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

上次更新： 2023-05-25
  • 主题：
  • Sources
    查看有关此主题的更多信息
  • 创建对象：
  • Developer
    User
    Admin
    Leader

基本连接表示源和Adobe Experience Platform之间经过身份验证的连接。

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

快速入门

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

  • 源： Experience Platform 允许从各种源摄取数据，同时让您能够使用以下方式构建、标记和增强传入数据： Platform 服务。
  • 沙盒： Experience Platform 提供对单个进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中，以帮助开发和改进数字体验应用程序。

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

收集所需的凭据

为了 Flow Service 以连接 Zoho CRM中，必须提供以下连接属性的值：

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

有关这些凭据的更多信息，请参阅以下文档： Zoho CRM 身份验证.

使用平台API

有关如何成功调用Platform API的信息，请参阅 Platform API快速入门.

创建基本连接

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

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

API格式

POST /connections

请求

小贴士

您的帐户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 与您的对应的客户端ID Zoho CRM 用户帐户。
auth.params.clientSecret 与您的对应的客户端密钥 Zoho CRM 用户帐户。
auth.params.accessToken 访问令牌可授权您对的安全临时访问 Zoho CRM 帐户。
auth.params.refreshToken 刷新令牌是在您的访问令牌过期后用于生成新访问令牌的令牌。
connectionSpec.id 的连接规范ID Zoho CRM： 929e4450-0237-4ed2-9404-b7e1e0a00309.

响应

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

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

后续步骤

按照本教程，您已创建了一个 Zoho 基本连接使用 Flow Service API。 您可以在以下教程中使用此基本连接ID：

上一页
Next page

在此页面上