Ruby SDK - Overview

Ruby SDK offers a way to create client Ruby applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs easy. In other words, it serves as a wrapper for the REST APIs, making it easier to use the services of Zoho CRM.

A sample of how an SDK acts a middleware or interface between Zoho CRM and a client Ruby application.

Ruby SDK allows you to:

  1. Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes.
  2. Declare and define CRM API equivalents as simple functions in your Ruby application.
  3. Push data into Zoho CRM by accessing appropriate APIs of the CRM Service.

Using the SDK

Add the below line in your client app Ruby files, where you would like to make use of the Ruby SDK.

require 'ZOHOCRMSDK2_0'

Through this line, you can access all the functionalities of the Ruby SDK.

Note

  • The access and refresh tokens are environment-specific and domain-specific. When you handle various environments and domains such as Production, Sandbox, or Developer and IN, CN, US, EU, or AU, respectively, you must use the access token and refresh token generated only in those respective environments and domains. The SDK throws an error, otherwise.
    For example, if you generate the tokens for your Sandbox environment in the CN domain, you must use only those tokens for that domain and environment. You cannot use the tokens generated for a different environment or a domain.

  • For Contact Roles and Records API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.modules.ALL scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error

  • For Related Records API, the scopes required for generating OAuthtoken are ZohoCRM.modules.ALL, ZohoCRM.settings.fields.ALL and ZohoCRM.settings.related_lists.ALL. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error