使用Flow Service API创建Zoho CRM基本连接

基本连接表示源和Adobe Experience Platform之间的已验证连接。

本教程将指导您完成使用Flow Service API为Zoho CRM创建基本连接的步骤。

开始使用

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:

  • : Experience Platform允许从各种源摄取数据,同时允许您使用Platform服务来构建、标记和增强传入数据。
  • 沙盒: Experience Platform提供将单个Platform实例划分为单独虚拟环境的虚拟沙盒,以帮助开发和改进数字体验应用程序。

以下部分提供了使用Flow Service API成功连接到Zoho CRM时需要了解的其他信息。

收集所需的凭据

为了使Flow Service与Zoho CRM连接,您必须提供以下连接属性的值:

凭据
描述
endpoint
您向其发出请求的Zoho CRM服务器的端点。
accountsUrl
帐户URL用于生成访问和刷新令牌。 URL必须特定于域。
clientId
与您的Zoho CRM用户帐户对应的客户端ID。
clientSecret
与您的Zoho CRM用户帐户对应的客户端密钥。
accessToken
访问令牌授权您对您的Zoho CRM帐户的安全临时访问。
refreshToken
刷新令牌是在您的访问令牌过期后用于生成新的访问令牌的令牌。
connectionSpec.id
连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 Zoho CRM的连接规范ID为: 929e4450-0237-4ed2-9404-b7e1e0a00309

有关这些凭据的详细信息,请参阅有关Zoho CRM 身份验证的文档。

使用平台API

有关如何成功调用平台API的信息,请参阅平台API快速入门指南。

创建基本连接

基本连接会保留您的源和平台之间的信息,包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。

要创建基本连接ID,请在提供Zoho CRM身份验证凭据作为POST参数的一部分时,向/connections端点请求请求。

API格式

POST /connections

请求

TIP
您的帐户URL域必须与适当的域位置相对应。 以下是各个域及其相应的帐户URL:
  • 美国: https://accounts.zoho.com
  • 澳大利亚:https://accounts.zoho.com.au
  • 欧洲:https://accounts.zoho.eu
  • 印度:https://accounts.zoho.in
  • 中国: https://accounts.zoho.com.cn

以下请求为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
Zoho CRM基本连接的名称。 您可以使用此名称查找您的Zoho CRM基本连接。
description
Zoho CRM基本连接的可选描述。
auth.specName
用于连接的身份验证类型。
auth.params.endpoint
您向其发出请求的Zoho CRM服务器的端点。
auth.params.accountsUrl
帐户URL用于生成访问和刷新令牌。 URL必须特定于域。
auth.params.clientId
与您的Zoho CRM用户帐户对应的客户端ID。
auth.params.clientSecret
与您的Zoho CRM用户帐户对应的客户端密钥。
auth.params.accessToken
访问令牌授权您对您的Zoho CRM帐户的安全临时访问。
auth.params.refreshToken
刷新令牌是在您的访问令牌过期后用于生成新的访问令牌的令牌。
connectionSpec.id
Zoho CRM的连接规范ID: 929e4450-0237-4ed2-9404-b7e1e0a00309

响应

成功的响应返回新创建的基本连接的详细信息,包括其唯一标识符(id)。 在下一步创建源连接时需要此ID。

{
    "id": "2484f2df-c057-4ab5-84f2-dfc0577ab592",
    "etag": "\"10033e77-0000-0200-0000-5e96785b0000\""
}

后续步骤

通过完成本教程,您已使用Flow Service API创建了Zoho基本连接。 您可以在下列教程中使用此基本连接ID:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089