Create a Zoho app & connect via Apideck
To create a connection with Zoho, you have to complete these steps:
Sign up for Zoho
Register for a developer account on Zoho People which is easy and free.
Log in to Zoho
After you are registered, you can log in to Zoho to create a "Client".
You can do this by navigating to https://api-console.zoho.com and login with your Zoho account.
Register a Zoho app
Add a client
You can create a new Zoho OAuth application by clicking on the "Add client" button on the top right of the applications overview page.
This will take you to a form where you select the type of application. Select "Server-based Applications" as the client type.
The next step is a form to enter information about your app:
- Client Name: Enter a meaningful name (for example, 'Apideck integration'), since when your users link their Zoho account, they will see the “App Client” is requesting to integrate with their Zoho account.
- Client Type: This is what you selected in the previous step. It should be set to "Server-based Applications" as the type of integration.
- Homepage URL: The homepage of your company’s website or the URL of your SaaS product.
- Authorized Redirect URIs: The URL where the user will be redirected after granting your app access to their Zoho account. This should be
https://unify.apideck.com/vault/callback
.
Client ID and Secret
The next step will show the OAuth 2.0 authentication credentials.
The Client ID & Secret are automatically generated.
💡 TIP: Copy the "Client Id" and the "Client secret". You will need them in one of the next steps.
Data center settings
Enable the "Settings" to match them with the regions that your customer will operate in.
Unify Connection Setup
Now that you have your Zoho App credentials, you can enable the integration to connect to Zoho instances in a secure manner.
Goto the Apideck > Configuration > Accounting > Zoho People
Enter the OAuth client ID & Secret from Zoho and review the scopes requested for Zoho.
Press "Save settings" to save your credentials.
You can test the connection by clicking "Test Vault", which will check if the connection is working.
Now you are ready and clients can authorize the connection to their Zoho account securely.
Do your first API call to the Zoho API
-
Connect a Zoho account through Vault with a test session.
-
To test the access token, make a query to get your
Employees
endpoint using the HRIS API.
curl --location --request GET 'https://unify.apideck.com/hris/employees' \
--header 'x-apideck-consumer-id: test-consumer' \
--header 'x-apideck-app-id: {APIDECK_APP_ID}' \
--header 'x-apideck-service-id: zoho-people' \
--header 'Authorization: Bearer {APIDECK_API_KEY}'
--header 'Content-Type: application/json' \