Overview
Configuration is provided for establishing connections with Zoho Desk service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to ZohoDesk REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Zoho Desk. Then click New in the Token File parameter to create a new token file.
Step 3. In following up wizard specify the orgId and add the desired scopes you want to generate token for. Then Click on ** Next**.
Step 4. In following up wizard specify the either email address or mobile number. Then Click on ** Next**.
Step 5. In following up wizard specify the password associated with your email address or mobile number. Then Click on ** SIGN IN**.
Step 6. If you have setup two factor authorization or you choose to provide OTP instead of providing password in the previous step then after completing the verification process In following up wizard specify the password associated with your email address or mobile number Click on ** Accept** in the next wizard.
Step 7: Save generated access token to file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Zoho Desk instance.
In this guide, we will show how to read data from the Zoho Desk service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Zoho Desk connection from the combo. Select from available Zoho Desk resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed or for addtional data in response.
Step 4. Click on the "Columns tab" and select Zoho Desk resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Zoho Desk service.
In this guide, we will show how to write data to the Zoho Desk service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Zoho Desk connection from the combo. Also, select resource action and Zoho Desk resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Zoho Desk resource.
Configuration
The provided configuration handles the authentication aspect of communicating with the service. To invoke endpoints, specific to you integration needs, consider defining custom resources (to be used with REST Source and/or REST Destination) or use the REST Web Service Request Task. If you have suggestions for further improvements, we will be happy to hear your feedback.
Download the configuration from here. Then review the KB article posted here how to use the configuration.
Base URL address: https://desk.zoho.com/api/v1.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300)}}.The authentication has the following user-defined parameters:
- orgId: Required. Specify organization id.
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
orgId:
{{=token.orgId}} -
Authorization:
Bearer {{=token.Access}}
For further information, please check here.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
from:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
from:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.