Technical Details

1. There are 3 modes of authentication, basic, OAuth 1.0 & OAuth 2.0.
2. Administrator privilege is required to use Connections.
3. Rest API and Deluge script knowledge is essential.
   

Creating a connection using Default Services 

1. Navigate to Settings > Developer Space > Connections > My Connections and click Create Connection.
   
   
   
   
2. In Pick your service, select Default services tab and select the service for which you would like to create connections.
   
   
   
3. Enter Connection Name and Link Name, Choose scopes and click Create and Connect.
   
   
4. Click on Connect.
   
   
5. Next, you will be prompted to Proceed and Sign in (in this case, you need the Slack workspace URL). Click Continue.
   
   
   
   
6. In the following page, the Link name, Service name and Status of the Connection is shown.
   
   
   
   
7. Additionally, the code to be used in a function to invoke the connection is also given in a box.
   

1. The URL can be obtained from the third-party service.
   
2. The Types POST, PUT, GET, and DELETE are the HTTP methods that determine the type of action that request performs.
3. The Parameters are used by the function to replace dynamic values present in the API with user-specific values. For example, if the API must fetch the lead's details such as name, email address, contact number, etc., these values will be represented by a dynamic value in the API. This dynamic value can be replaced with the actual value from the Leads Details page using the parameter function. Examples given later in this document will give more detailed information about this function.
4. The Connection in the code is the link name.
   

You can use the above block of code to invoke the URL and integrate the third-party app with Zoho People.

1. Resource - The application or service that the client is trying to access. In our case, the resource is the third-party service (ex: MailChimp) you are trying to integrate.
2. 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.
3. 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.
4. 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.
5. Client ID - A unique identifier provided to every client application. This ID is provided by the resource owner (ex: MailChimp).
6. Client Secret - Every client application has a secret code mapped to it. This is done to prevent unauthorized access to the resource.
7. 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.
   

Registering a Zoho Client

Note: Please note that the following steps has to be followed for Apps only when you want to add a Custom Service in Connections.

Sample Connection

1. Go to Settings > Developer Space > Connections > My Connections and click Create Connection.
2. Click the Custom Service tab.
3. Give the Service name as Zoom Meeting.
4. Enter a Service Link Name.
5. Set the Authentication type as OAuth 2.
   
6. Set Parameter Type as Header, Grant Type as Client Credentials.
7. Provide the following information:
   
1. Client ID : {your_client_id}
   
2. Client Secret : {your_client_secret}
   
3. Authorize URL : https://zoom.us/oauth/authorize
   
4. Access Token URL : https://zoom.us/oauth/token
   
5. Refresh Token URL : https://zoom.us/oauth/token 
8. Give a name for the Connection.
   
9. Provide the Scopes for the connection as specified by Zoom.
   
10. Click Create Service.
    
11. Click Create Connection in the service summary.
    
12. Click Create and Connect in the connection details page.
    
13. Now the connections will be established and a success message should be displayed. The code displayed in the connection summary screen can be used in custom functions.
    
14. You can now create a custom function to invoke this connection. The code displayed above can be used. GET/POST/PUT/DELETE operations can be performed.