Register your Application
Before you get started with authorization and make any calls using the Zoho Vertical Solution APIs, you need to register your application with Vertical Solutions.
To register,
If you are a Subscriber : Go to Set UP > Developer Space > APIs and click on the ? > API Console
If you are a Zoho Vertical Solutions Developer, and if you wish to create an API integration for your solution from the developer console, click on the API Console button inside the respective solution.
You will be presented with the different client-types to choose from.
- In API Console, Select client-type as Server Based application.
- Enter the following details:
- Client Name: The name of your application you want to register with Vertical Solutions.
- Homepage URL: The URL of your web page.
Authorized Redirect URIs: A valid URL of your application to which which you will be redirected after successful authentication with a grant token.
- Click CREATE.
- You will receive the following credentials:
- Client ID: The consumer ID generated.
- Client Secret: The consumer secret generated.
Note
If you don't have a domain name and a redirect URL, you can use dummy values in their place and register your client.
Possible Errors
- Enter a valid client name
Resolution: The client name has a special character. The client name must not contain any special characters except "_" and "&".
- Enter a valid JavaScript Domain URI
Resolution: The JavaScript domain is incorrect. Specify valid JavaScript domains, separated by commas, and they must start with 'http'.
- Enter a valid redirect URI
Resolution: The redirect URI is incorrect. Specify a valid redirect URI in the format "https://www.your-domain.com/callback".
- Enter a valid homepage URL
Resolution: The homepage URL is invalid. Specify a valid homepage URL in the format "https://www.yourdomain.com".
Mandatory Entries for Different Client Types
The following are the mandatory entries for different client types.
| Client Type | Client Name | Homepage URL | Redirect URIs | JS Domains |
|---|---|---|---|---|
| Java Script | Y | Y | Y | Y |
| Web-based | Y | Y | Y | NA |
| Mobile | Y | Y | Y | NA |
| Device | Y | Y | N | NA |