1. Oauth 2.0
   
2. Create a connector 
   
3. Add APIs 
   
4. Publish the connector 
   
5. Associate to an extension 
   
6. Invoke connectors 
   
7. Sample Connector  
   

OAuth 2.0

Important terminology

1. Client - The application requesting access to data stored in an external system. When creating a connector in Zoho Developer Console, the client is Zoho CRM or your custom vertical CRM system.
   
2. Resource - The application or service that the client is trying to access. In our case, the resource is the third-party service (ex: Dropbox) you are trying to integrate.
   
3. Request Token URL - This URL is used to send authorization requests to the resource server. The resource server prompts the resource owner (user) to authorize this request.
   
4. Access Token URL - Once the request is authorized by the resource owner, the server sends an access token to the client. This token has to be exchanged every time the clients wants to access the resource data.
   
5. Refresh Token URL - Some access tokens are valid only for a limited period of time. When an access token expires, the client has to get another access token from the resource, using the refresh token URL.
   
6. Client ID - A unique identifier provided to every client application. This ID is provided by the resource owner.
   
7. Client Secret - Every client application has a secret code mapped to it. This is done to prevent unauthorized access to the resource.
   
8. Redirect URL - This is the URL to which the end user will be redirected, once data access has been authorized. The client application will generate a redirect URL automatically.
   

Create a connector

1. Log in to Zoho Developer console and click Build Connectors.
   
2. Click Create Connector.
   
3. Provide a suitable name and description for the connector.
   
4. Provide the following details about the third-party server:
   
1. Request Token URL: This allow the connector to request authorization to access data on the resource server.
   
2. Access Token URL: Once authorized, the Request Token and Token Key will be exchanged for the Access Token, allowing the connector to draw specific information from the third-party server.
   
3. Refresh Token URL: Some applications increase security by limiting the duration of time a particular token is valid. In these cases, you will need to provide the Refresh Token URL to allow the connector to reauthorize access.
   
5. Click Save.
   
6. Provide the Client ID and Client Secret of your application in the space provided.
   This Client ID and Client secret can be obtained by creating a OAuth 2.0 client/ application (terminology varies with the resource application) . An example  is provided at the bottom of this page.
7. Copy the Redirect URL available in the Set Client Credentials page and enter it in the appropriate space in your web application.
   This is the URL to which the user will be redirected once the authorization process is complete.
8. Click Save.
   
   

1. Provide a name for the API.
   
2. Choose the Method type and provide the API URL.
   The API method type and the API URL can be obtained from the resource application.
   Incase your API's URL contains dynamic values, they should be preceded by a "$" symbol and enclosed within {..}.
   For example, http://example.com/callback?id=${myid}&key=${mykey}.
   Here myid and mykey are dynamic variables whose values you will have to define in the custom function that is used to invoke  this API.
3. Specify the header fields and URL parameters
   

1. In the Connectors page, hover over the connector containing the API to be executed and click View All API.
   A new page will appear, displaying all APIs associating with the connector.
2. Click Execute next to the API you're interested in. 
   

Publish a connector

1. In the Connectors page, hover over the connector in which the API has to be added and click View All API.
   
2. Hover over the API you'd like to publish and click the Publish.   
   
3. Click OK.
   

Add connector to an extension

1. In your Zoho Developer Console home page, click Extensions for Zoho CRM.
   
2. Select the extension to which you'd like to associate the connector.
   
3. Click Connectors in the left pane.
   
4. Click Add Connector.
   
5. Choose the connector you'd like to add from the list of available connectors and click Add.    
   
6. In the resulting pop up, enter the Client ID and Client Secret, unique codes provided by the third-party service.
   This will be used to authorize your account during the integration.
7. Copy the auto-generated Redirect URL available in this page and provide it to the third-party service.
   

Note

Only the connectors that have been published will be displayed in the list of connectors in Add Connector pop-up. Before trying to add a connector with an extension make sure it is published and ready to access.

 Invoke Connectors

1. In the Extension's Details page click Connectors and select the connector you're working on.
   
2. Click View All APIs and select the API you're interested in. The page that appears contains the unique API identifier.
   

This page will contain the API unique- identifier.

An example custom function is provided here .

Step 1: Provide the Request, Access, and Refresh Token URLs

1. In your Zoho Developer Console homepage, click Build Connectors.
   
2. Click Create Connector.
   
3. Provide the Request, Access, Refresh token URLs for Google Contacts:
   
1. Request Token URL:
   https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.google.com/m8/feeds
2. Access Token URL:
   https://www.googleapis.com/oauth2/v4/token
3. Refresh Token URL:
   https://www.googleapis.com/oauth2/v4/token
   
4. Click Save.
   

Note

1. The basic format for a Request Token URL is <requesttokenURL>?scope="<scopelink>".
   
2. To create a specific Request token for Google Contacts, combine the Google Request token URL ("https://accounts.google.com/o/oauth2/v2/auth") with the scope for Google Contacts ("https://www.google.com/m8/feeds").
   
3. Thus the complete request token URL should be
   https://accounts.google.com/o/oauth2/v2/auth?scope=https://www.google.com/m8/feeds

Step 2: Provide the Client ID and Client Secret

1. In the Google Developer Console home-page , click Select a Project in the upper right corner of the screen. A drop-down list will open. Choose Create a Project. 
   
2. Provide a name for your project.
   
3. A default Project ID based on the project name will be generated. Click Edit to change the ID.
   
4. Click Create. 
   
   
   
   
5. Click Enable and Manage APIs at the top of the dashboard on the Google Developer Console.
   
6. Click Google APIs and select Contacts API under the Google Apps APIs tab.
   
7. Click Enable.
   
8. Once the API is enabled, choose Credentials in the left pane.
   
9. Click Create Credentials and select OAuth Cliend ID.     
   

1. Select Web application as the Application type.
   
2. Provide a Name for the credential.
   
3. Provide a Redirect URL.
   This URL can be obtained from the Zoho Developer Console.
4. Click Create.
   

      Copy the ID and Client Secret and paste them into the Zoho developer console.

Step 3: Authorize your connector

1. In your Zoho Developer Console home page, click Connectors.
   
2. Click Add API next to the connector you're wokring on.
   
3. Fill in the required details on the Create Connector API page.
   
4. To add new contacts to your Google Contacts, fill in the following API details:
   
1. Method type- Post
   
2. API URL- https://www.google.com/m8/feeds/contacts/{userEmail}/full
   In place of "useremail" use default to refer to the authenticated user.
3. Header Fields- Content-Type: application/atom+xml
   
4. Request Body-
   

1. The APIs for other operations are available here .
   

Step 5: Write a custom function to invoke the connector

1. Module: Contacts
   
2. Rule Trigger: Based on a record action whenever a record is created.
   
3. Rule Criteria: Mailing country is Ireland.
   
4. Instant Action: Call Custom Functions
   

2. Get data from Google Contact to your Zoho CRM.