Node JS SDK - Overview

Zoho CRM NodeJS SDK offers a way to create client NodeJS 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 interface implementations, instances or objects. Authentication to access Zoho CRM APIs is through OAuth2.0 authentication mechanism. Invariably, HTTP requests and responses are taken care of by the SDK.

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

C Sharp SDK Middleware Image

Node JS SDK allows you to

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

Environmental Setup

NodeJS SDK is installable through npm. npm is a tool for dependency management in NodeJS. SDK expects the following from the client app:

  • Client app must have Node(version 12 and above)
  • NodeJS SDK must be installed in the client app through npm.

Including the SDK in your project

  • Install Node from nodejs.org (if not installed).
  • Install NodeJS SDK
    • Navigate to the workspace of your client app.
    • Run the command below:
      npm install @zohocrm/nodejs-sdk-2.0
  • The NodeJS SDK will be installed and a package named @zohocrm/nodejs-sdk-2.0 will be created in the local machine.
  • Another method to install the SDK:
    • Add dependencies to the package.json of the node server with the latest version (recommended)
    • Run npm install in the directory which installs all the dependencies mentioned in package.json.
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