Zoho CRM Query Authentication Guide

Zoho CRM Query Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Zoho CRM Query connector for use in Matillion ETL.

Important Information

  • The Zoho CRM Query connector uses an OAuth for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left of the screen, click ProjectManage OAuth.

    Please Note

    If a Zoho CRM Query connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

    1. Click the connector icon to open the Properties panel at the bottom of the screen.
    2. Click ... next to the Authentication input, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth Entry

  4. Click the Service dropdown menu and select Zoho. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    OAuth Entry list

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the Zoho CRM Accounts portal. The Zoho CRM login screen will appear immediately. Enter valid login credentials to continue. The browser will then redirect to the Zoho CRM Accounts API Credentials dashboard. Click Add Client to the right of the page.

    Add Client

    Add Client

  2. Next, Choose a Client Type window will appear. Select the Server-based Application from the available options.

    Choose Client Type

    Choose Client Type

  3. On the Create New Client window, provide details for the following fields:

    • Client Type – This returns the type of client you have selected before. If any change is required, select the client type from the dropdown.
    • Client Name – Provide a descriptive name for the Client.
    • Homepage URL – Provide the domain URL to be associated with the Client.
    • Authorized Redirect URIs – Paste the Callback URL (copied earlier from the Manage OAuth window from Matillion ETL), then click Create.

    Create New Client

    Create New Client

  4. If the details for the app are accepted, the screen will refresh, and the new Client window will appear which you have created. Client ID and Client Secret will be generated and appear on the screen. Copy the codes next to Client ID and Client Secret, as they will be required in Authorising for Use in Matillion ETL.

    Please Note

    • Make sure to copy the Client Secret right away as it may appear only once.
    • Additionally, when copying the codes, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
    Copy Client ID and Client Secret

    Copy Client ID and Client Secret


Authorising OAuth for use in Matillion ETL

  1. Return to the Manage OAuth window in Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Manage OAuth

    Manage OAuth

  2. Using the codes copied from the Zoho CRM Accounts portal earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings

  3. The next window will have an Authorization Link. click the link to authorise Matillion ETL to use the acquired credentials.

    Authorization Link

    Authorization Link

  4. The browser will redirect to a Zoho screen requesting access to data from the associated Zoho CRM account. Click Accept to confirm.

    Allow access to Zoho account

    Allow access to Zoho account

  5. If all is successful, the browser will return to Matillion ETL with a window stating, "Authorization Successful".

    Authorization successful

    Authorization successful