Create a Zoho CRM base connection using the Flow Service API
A base connection represents the authenticated connection between a source and Adobe Experience Platform.
This tutorial walks you through the steps to create a base connection for Zoho CRM using the Flow Service API.
Getting Started
This guide requires a working understanding of the following components of Adobe Experience Platform:
- Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Platform services.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.
The following sections provide additional information that you need to know in order to successfully connect to Zoho CRM using the Flow Service API.
Gather required credentials
In order for Flow Service to connect with Zoho CRM, you must provide values for the following connection properties:
endpoint
accountsUrl
clientId
clientSecret
accessToken
refreshToken
connectionSpec.id
929e4450-0237-4ed2-9404-b7e1e0a00309
.For more information on these credentials, see the documentation on Zoho CRM authentication.
Using Platform APIs
For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.
Create a base connection
A base connection retains information between your source and Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.
To create a base connection ID, make a POST request to the /connections
endpoint while providing your Zoho CRM authentication credentials as part of the request parameters.
API format
POST /connections
Request
- United States: https://accounts.zoho.com
- Australia: https://accounts.zoho.com.au
- Europe: https://accounts.zoho.eu
- India: https://accounts.zoho.in
- China: https://accounts.zoho.com.cn
The following request creates a base connection for Zoho CRM:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json'
-d '{
"name": "Zoho CRM base connection",
"description": "Base Connection for Zoho CRM",
"auth": {
"specName": "Basic Authentication",
"params": {
"endpoint": "{ENDPOINT}",
"accountsUrl": "{ACCOUNTS_URL}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}",
"accessToken": "{ACCESS_TOKEN}",
"refreshToken": "{REFRESH_TOKEN}"
}
},
"connectionSpec": {
"id": "929e4450-0237-4ed2-9404-b7e1e0a00309",
"version": "1.0"
}
}'
name
description
auth.specName
auth.params.endpoint
auth.params.accountsUrl
auth.params.clientId
auth.params.clientSecret
auth.params.accessToken
auth.params.refreshToken
connectionSpec.id
929e4450-0237-4ed2-9404-b7e1e0a00309
.Response
A successful response returns details of the newly created base connection, including its unique identifier (id
). This ID is required in the next step to create a source connection.
{
"id": "2484f2df-c057-4ab5-84f2-dfc0577ab592",
"etag": "\"10033e77-0000-0200-0000-5e96785b0000\""
}
Next steps
By following this tutorial, you have created a Zoho base connection using the Flow Service API. You can use this base connection ID in the following tutorials: