Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Zoho Projects via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:

• set AuthScheme to OAuth,
• get and set the OAuthAccessToken, and
• set the necessary configuration parameters.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Establishing a Connection".)

However, you must create a custom OAuth application to connect to Zoho Projects via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Procedure

To create a custom OAuth application and obtain the OAuthClientId, OAuthClientSecret, and CallbackURL:

1. Navigate to the Zoho Developer Console.
2. Click Add Client, then Server-Based Application.
3. Enter the client name, homepage URL, and redirect URL.
4. If the user will connect via either desktop or Web, set a callback URL:
   • For desktop applications, set the callback URL to http://localhost:33333, or another port number of your choice.
   • For Web applications, set a callback URL to specify what page the user should land on after they grant your application access.
5. Click Create.