Register the Client Application in Zoho API Console

We must now register the client application in the Zoho API console, to generate the following credentials:

Client ID: The unique key generated for a registered client
Client Secret: The secret value generated for a registered client’s Client ID

The Client ID and Client Secret are added in the function and client code in several places. These values are necessary to generate the Access Token and Refresh Token initially, and later to refresh the Access Token using the Refresh Token.

To register the client application in Zoho API console:

Visit the Zoho API Console and click Get Started.
Select Server-based Applications as the client type.
Enter “LeadManagerApp” as the client name.

catalyst_leadmanager_api_console_2
Provide the other details in the following format:

Homepage URL: {APP\DOMAIN}/app/index.html
Authorized Redirect URIs: {APP\DOMAIN}/server/crm_crud/generateToken

Replace {APP_DOMAIN} with the application URL value of the LeadManager project you created in Catalyst. The application URL follows the below syntax :

https://{project name}-{orgID}.development.catalystserverless.com

Note:

You can fetch the project name by navigating to Settings in the top right corner of the Catalyst console. Then go to Project Settings->General. Please make sure to enter your project name in small case without any spaces in the domain URL.
You can fetch the Org id value directly from the URL in the Catalyst console. Say for example in the below URL, “687259092” is the Org Id.

https://console.catalyst.zoho.com/baas/687259092/project/11811000000477018/Development

For example, the homepage URL in this case will be:

https://leadmanager-687259092.development.catalystserverless.com/app/index.html.

And the redirect URL will be:

https://leadmanager-687259092.development.catalystserverless.com/server/crm_crud/generateToken

We enter the path to the index page of the client as the homepage URL, and a route defined in the Node.js function as an authorized redirect URI. We will discuss these steps in the next sections.

You must add another Authorized Redirect URI for the client. We will serve the app through a localhost to test it after configuring the code. Because this will be redirected to a local domain, we must add that as another authorized redirect URI.

Click the (+) icon under Authorized Redirect URIs and add: “http://localhost:3000/server/crm_crud/ generateToken”

catalyst_leadmanager_api_console_4

Note: When you serve an application locally from the CLI, it is hosted from port 3000 by default. We are therefore adding the domain accordingly.

Click Create after configuring these details.

The API console will generate and display the Client ID and Client Secret values for the registered client.

catalyst_leadmanager_api_console_3

You will need to copy these values and paste them into the function and client files in your project directory. We will discuss this in the next section.

Last Updated 2024-01-04 12:37:42 +0530 +0530

Catalyst CLI Documentation