Node JS SDK - An Overview

Node JS SDK - An Overview


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

A point to note would be that the developer of the client application should create programming code elements along with configuration-related properties files, interface implementations, instances or objects. Authentication to access Zoho CRM APIs is through OAuth authentication mechanism. Invariably, HTTP requests and responses are taken care by SDK.

A sample of how an SDK acts a middle ware or interface between Zoho CRM and a client java application.



Node JS SDK allows you to:
  1. Exchange data between Zoho CRM and the client application where the CRM entities are modelled as classes. 
  2. CRM API equivalents are declared and defined as simple member methods in your node js application. 
  3. Push data into Zoho CRM, by accessing appropriate APIs of the CRM Service.

Response Handling

All API calls will give the actual API response given by Zoho APIs, except file download. For file download, the response will contain an extra field filename.

Error Handling

All errors will be thrown explicitly and care should be taken in catching the same.

    • Related Articles

    • Installation - Node JS SDK

      Node JS SDK will be installed and a package named 'zcrmsdk' will be created in the local machine. The package can be added using the following code: var ZCRMRestClient = require('zcrmsdk') Installing the SDK Run the command below to install the Node ...

    • Initialization - Node JS SDK

      Whenever the app is started, the below code snippet is to be called for initialization. var ZCRMRestClient = require('zcrmsdk'); ZCRMRestClient.initialize().then(function() { //do whatever required after initialize }) Generating self-authorized grant ...

    • Configuration - Node JS SDK

      Your OAuth Client details should be given to the SDK as a property file. In the SDK, you need to configure a file named oauth_configuration.properties. Please place the respective values in that file. You can place it under resources folder from ...

    • Class Hierarchy - Node JS SDK

      All Zoho CRM entities are modelled as modules having classes, methods and instance variables applicable to that particular entity. ZCRMRestClient is the base class of the Python SDK. ZCRMRestClient has methods to get instances of various other Zoho ...

    • Register your application - Node JS SDK

      All the Zoho CRM APIs are authenticated with OAuth2 standards, so it is mandatory to register and authenticate your client app with Zoho. To register: Go to the site: accounts.zoho.com/developerconsole Click Add Client ID.  Enter the Client ...