The Ruby SDK for Zoho CRM allows developers to easily create Ruby applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM. Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the Ruby SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application.

This repository includes the Ruby SDK for API v5 of Zoho CRM. Check Versions for more details on the versions of SDK released for this API version.

Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED 
All rights reserved. 

Licensed under the Apache License, Version 2.0 (the "License"); 
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at 

    http://www.apache.org/licenses/LICENSE-2.0 

Unless required by applicable law or agreed to in writing, software 
distributed under the License is distributed on an "AS IS" BASIS, 
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
See the License for the specific language governing permissions and 
limitations under the License.

• 2.0.0

  • Update RecordLockingOperations class constructor and methods.

  • Added new parentColumnIndex field in BulkWrite FieldMapping class.

  • Added new fileNames field in BulkWrite Resource class.

  • Support for the following new APIs.

    • MailMerge:
      • Send Mail Merge
      • Sign Mail Merge
      • Download Mail Merge

• 1.0.0

  • Added new key in FileStore and DBStore

  • Added a new key find_user in OAuthToken.

    • By default, the find_user key is set to true, to set userSignature. However, this requires the ZohoCRM.users.READ and ZohoCRM.org.READ scopes to be mandatory. If you do not want to set userSignature, you must set the find_user key to false.

  • Ruby SDK upgraded to support v5 APIs.

  • Ruby SDK improved to support the following new APIs

    • User Groups API
    • Fiscal Years
    • Timeline API
    • Transfer and Delete Users
    • Territories
    • Territories Users
    • Organization API
    • Record Locking API

For older versions, please refer.

You can include the SDK to your project using:

• For including the latest version

  • Ruby SDK is available through Gem . You can download the gem using: gem install ZOHOCRMSDK5_0

  • You can include the SDK to your project using: require 'ZOHOCRMSDK5_0'

• Dependencies that should be included in the project
  • install cgi

      gem install cgi

  • install csv

      gem install csv

  • install json

      gem install json

  • install multipart-post

      gem install multipart-post

  • install rest-client

      gem install rest-client

  • install uri

      gem install uri

  • install mysql2

      gem install mysql2

  • install tzinfo

      gem install tzinfo

  • install webrick

      gem install webrick

For more details, kindly refer here.