Register your Application

Before you get started with authorization and make any calls using the Zoho Assist APIs, you need to register your application with Zoho Assist.

To register,

  • Go to Zoho Developer Console.

  • Choose a client type:

    For more details, refer to OAuth Overview.


    Enter the following details:
    • Client Based: Applications that run exclusively on a browser and are independent of a web server.

    • Web Based: Applications that are clients running on a dedicated HTTP server.

    • Mobile: Applications that are installed on smart phones and tablets.

    • Non-browser Mobile Applications: Applications for devices without browser provisioning such as smart TVs and printers.

    • Self Client: Stand-alone applications that perform only back-end jobs (without any manual intervention) like data sync.

 
  • Client Name: The name of your application you want to register with Zoho.
  • Homepage URL: The URL of your web page.

  • Authorized Redirect URIs: A valid URL of your application to which Zoho Accounts redirects you with a grant token(code) after successful authentication.

  • Click CREATE.

  • You will receive the following credentials:

    • Client ID: The consumer key generated from the connected app.

    • Client Secret: The consumer secret generated from the connected app.

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 TypeClient NameHomepage URLRedirect URIsJS Domains
Client BasedYYYY
Web-basedYYYNA
MobileYYYNA
Self ClientNNNNA
DeviceYYNNA