ZOHO CRM TYPESCRIPT SDK 5.0 for API Version 5

The TypeScript SDK for Zoho CRM allows developers to easily create TypeScript 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 TypeScript 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 TypeScript SDK for API v5 of Zoho CRM. Check Versions for more details on the versions of SDK released for this API version.

License

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.

Latest Version

• 2.0.0

  • Handled the sdk_tokens and resources file path issue in InitializeBuilder.

• 1.0.0

  • Added the new key (api_domain) in FileStore and DBStore.

  • TypeScript SDK upgraded to support v5 APIs.

  • TypeScript 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.

Including the SDK in your project

You can include the SDK to your project using:

For including the latest version using npm

• Install Node from nodejs.org (if not installed).

• Install TypeScript SDK

  • Navigate to the workspace of your client app.

  • Run the command below:

    npm install @zohocrm/typescript-sdk-5.0

Dependencies

• Dependencies that should be included in your project

  • install form-data

    npm i form-data

  • install ts-node

    npm i ts-node

  • install typescript

    npm i typescript

  • install got

    npm i got

  • install moment-timezone

    npm i moment-timezone

  • install mysql

    npm i mysql

  • install tunnel

    npm i tunnel

  • install winston

    npm i winston

  • install @types/mysql

    npm i @types/mysql

  • install @types/tunnel

    npm i @types/tunnel

For more details, kindly refer here.