Show Menu
主题×

使用Flow Service API创建HubSpot连接器

Flow Service用于收集和集中Adobe Experience Platform内不同来源的客户数据。 该服务提供用户界面和RESTful API,所有支持的源都可从中连接。
本教程使用Flow Service API指导您完成将Experience Platform连接到HubSpot的步骤。

入门指南

本指南需要对Adobe Experience Platform的以下组件有充分的了解:
  • 来源 :Experience Platform允许从各种来源摄取数据,同时使您能够使用平台服务来构建、标记和增强传入数据。
  • 沙箱 :Experience Platform提供虚拟沙箱,将单个Platform实例分为单独的虚拟环境,以帮助开发和发展数字体验应用程序。
以下各节提供了使用Flow Service API成功连接到HubSpot所需了解的其他信息。

收集所需的凭据

要使Flow Service与HubSpot连接,您必须提供以下连接属性:
凭证
描述
clientId
与您的HubSpot应用程序关联的客户端ID。
clientSecret
与您的HubSpot应用程序关联的客户端机密。
accessToken
首次验证OAuth集成时获得的访问令牌。
refreshToken
首次验证OAuth集成时获取的刷新令牌。
有关快速入门的详细信息,请参阅此 HubSpot文档

读取示例API调用

本教程提供示例API调用,以演示如何设置请求的格式。 这些包括路径、必需的标题和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅Experience Platform疑难解答指南 中有关如何阅读示例API调用的部分

收集所需标题的值

要调用平台API,您必须首先完成身份验证 教程 。 完成身份验证教程后,将为所有Experience Platform API调用中的每个所需标头提供值,如下所示:
  • 授权:承载人 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platform中的所有资源(包括属于流服务的资源)都与特定虚拟沙箱隔离。 对平台API的所有请求都需要一个标头,它指定操作将在以下位置进行的沙箱的名称:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标题:
  • 内容类型: application/json

查找连接规范

要创建HubSpot连接,Flow Service中必须有一组HubSpot连接规范。 连接Platform和HubSpot的第一步是检索这些规范。
API格式
每个可用源都有其自己唯一的连接规范集,用于描述连接器属性,如身份验证要求。 向端点发送GET请求将返 /connectionSpecs 回所有可用源的连接规范。 您还可以包含查询,以 property=name=="hubspot" 获取HubSpot的专用信息。
GET /connectionSpecs
GET /connectionSpecs?property=name=="hubspot"

请求
以下请求检索HubSpot的连接规范。
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="hubspot"' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应会返回HubSpot的连接规范,包括其唯一标识符( id )。 下一步中需要此ID才能创建API连接。
{
    "items": [
        {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "name": "hubspot",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to HubSpot",
                        "properties": {
                            "clientId": {
                                "type": "string",
                                "description": "The client ID associated with your HubSpot application."
                            },
                            "clientSecret": {
                                "type": "string",
                                "description": "The client secret associated with your HubSpot application.",
                                "format": "password"
                            },
                            "accessToken": {
                                "type": "string",
                                "description": "The access token obtained when initially authenticating your OAuth integration.",
                                "format": "password"
                            },
                            "refreshToken": {
                                "type": "string",
                                "description": "The refresh token obtained when initially authenticating your OAuth integration.",
                                "format": "password"
                            }
                        },
                        "required": [
                            "clientId",
                            "clientSecret",
                            "accessToken",
                            "refreshToken"
                        ]
                    }
                }
            ],
        }
    ]
}

为API创建连接

API连接指定源并包含该源的凭据。 每个HubSpot帐户只需要一个API连接,因为它可用于创建多个源连接器以导入不同的数据。
API格式
POST /connections

请求
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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "connection for hubspot",
        "description": "connection for hubspot",
        "auth": {
            "specName": "Basic Authentication",
            "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集成时获取的刷新令牌。
响应
成功的响应会返回新创建的API连接的详细信息,包括其唯一标识符( id )。 在下一个教程中浏览数据时需要此ID。
{
    "id": "2eb9c78b-e8b8-4400-b9c7-8be8b86400b2",
    "etag": "\"05026cf5-0000-0200-0000-5e4c42920000\""
}

通过本教程,您使用Flow Service API创建了一个HubSpot连接,并获得了该连接的唯一ID值。 在下一个教程中,您可以使用此连接ID,因为您将学习如 何使用Flow Service API浏览CRM系统