https://github.com/zoho/zohocrm-typescript-sdk-5.0
https://github.com/zoho/zohocrm-typescript-sdk-5.0
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zoho/zohocrm-typescript-sdk-5.0
- Owner: zoho
- License: apache-2.0
- Created: 2023-10-06T10:08:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-28T09:49:43.000Z (over 2 years ago)
- Last Synced: 2025-09-25T20:33:02.882Z (6 months ago)
- Language: TypeScript
- Size: 867 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/zoho/zohocrm-typescript-sdk-5.0/releases) 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](/versions/2.0.0/README.md)
- Handled the sdk_tokens and resources file path issue in InitializeBuilder.
- [1.0.0](/versions/1.0.0/README.md)
- 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](https://www.zoho.com/crm/developer/docs/api/v5/associated-user-count-user-group.html)
- [Fiscal Years](https://www.zoho.com/crm/developer/docs/api/v5/get-fiscal-year.html)
- [Timeline API](https://www.zoho.com/crm/developer/docs/api/v5/timeline-of-a-record.html)
- [Transfer and Delete Users](https://www.zoho.com/crm/developer/docs/api/v5/transfer_records-delete_user.html)
- [Territories](https://www.zoho.com/crm/developer/docs/api/v5/add-territories.html)
- [Territories Users](https://www.zoho.com/crm/developer/docs/api/v5/associate-users-territory.html)
- [Organization API](https://www.zoho.com/crm/developer/docs/api/v5/delete-org-img.html)
- [Record Locking API](https://www.zoho.com/crm/developer/docs/api/v5/get-record-locking-info.html)
For older versions, please [refer](https://github.com/zoho/zohocrm-typescript-sdk-5.0/releases).
## Including the SDK in your project
You can include the SDK to your project using:
For including the latest [version](https://github.com/zoho/zohocrm-typescript-sdk-5.0/releases/tag/2.0.0) using npm
- Install **Node** from [nodejs.org](https://nodejs.org/en/download/) (if not installed).
- Install **TypeScript SDK**
- Navigate to the workspace of your client app.
- Run the command below:
```sh
npm install @zohocrm/typescript-sdk-5.0
```
### Dependencies
- Dependencies that should be included in your project
- install **form-data**
```sh
npm i form-data
```
- install **ts-node**
```sh
npm i ts-node
```
- install **typescript**
```sh
npm i typescript
```
- install **got**
```sh
npm i got
```
- install **moment-timezone**
```sh
npm i moment-timezone
```
- install **mysql**
```sh
npm i mysql
```
- install **tunnel**
```sh
npm i tunnel
```
- install **winston**
```sh
npm i winston
```
- install **@types/mysql**
```sh
npm i @types/mysql
```
- install **@types/tunnel**
```sh
npm i @types/tunnel
```
For more details, kindly refer [here](/versions/2.0.0/README.md).