使用Flow Service API创建HubSpot基本连接

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

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

快速入门

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

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

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

收集所需的凭据

为了使Flow Service与HubSpot连接,您必须提供以下连接属性:

凭据
描述
clientId
与您的HubSpot应用程序关联的客户端ID。
clientSecret
与您的HubSpot应用程序关联的客户端密钥。
accessToken
最初验证您的OAuth集成时获得的访问令牌。
refreshToken
最初对您的OAuth集成进行身份验证时获得的刷新令牌。
connectionSpec.id
连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 HubSpot的连接规范ID为: cc6a4487-9e91-433e-a3a3-9cf6626c1806。

有关入门的详细信息,请参阅此HubSpot文档。

使用Experience Platform API

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

创建基本连接

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

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

API格式

POST /connections

请求

以下请求为HubSpot创建基本连接:

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": "connection for HubSpot",
        "description": "connection for HubSpot",
        "auth": {
            "specName": "OAuth2 Refresh Code",
            "params": {
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }
属性
描述
auth.params.clientId
与您的HubSpot应用程序关联的客户端ID。
auth.params.clientSecret
与您的HubSpot应用程序关联的客户端密钥。
auth.params.accessToken
最初验证您的OAuth集成时获得的访问令牌。
auth.params.refreshToken
最初对您的OAuth集成进行身份验证时获得的刷新令牌。
connectionSpec.id
HubSpot连接规范ID: cc6a4487-9e91-433e-a3a3-9cf6626c1806。

响应

成功的响应返回新创建的连接,包括其唯一连接标识符(id)。 在下个教程中,需要此ID才能浏览您的数据。

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

创建源连接

源连接由连接ID、查找源数据所需的信息以及连接规范ID组成。 Source连接与基本连接、目标连接和映射ID结合使用,以创建数据流。

要创建源连接,请向Flow Service API的/sourceConnections端点发出POST请求,并提供您的基本连接ID和要摄取的HubSpot表的名称。

API格式

POST /sourceConnections

请求

以下请求为HubSpot创建源连接:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "HubSpot source connection",
        "baseConnectionId": "b4a738db-8696-4e2a-bf95-08d2927c911e",
        "description": "HubSpot source connection",
        "params": {
            "columns": [],
            "tableName": "CRM.Objects.Contacts"
        },
        "data": {
            "format": "tabular",
            "schema": null,
            "properties": null
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }'
属性
描述
baseConnectionId
您在上一步中创建的HubSpot基本连接的唯一连接ID。
params.columns
要纳入Experience Platform的特定数据表列。 将此值保留为空数组可摄取所有列。
params.tableName
要提取的HubSpot表的名称,格式为<HubSpot Category>.<Sub Category>.<Object Name>。 例如:CRM.Commerce.Discounts。
connectionSpec.id
HubSpot连接规范ID: cc6a4487-9e91-433e-a3a3-9cf6626c1806。

响应

成功的响应返回新创建的源连接,包括其唯一连接标识符(id)。

{
    "id": "cbfd6fe0-0d1f-4c26-bd06-f00d1f4c26fc",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0001\""
}

后续步骤

通过学习本教程,您已使用Flow Service API创建了HubSpot基本连接和源连接。 您可以在以下教程中使用这些连接ID:

recommendation-more-help
experience-platform-help-sources