Show Menu
主题×

使用API Experience Platform 创建数据集基础连 Flow Service 接

Flow Service 用于收集和集中Adobe Experience Platform内不同来源的客户数据。 该服务提供用户界面和RESTful API,所有支持的源都可从中连接。
要将数据从第三方源连接到第 Platform三方源,必须先建立数据集基础连接。
本教程使 Flow Service 用API指导您逐步创建数据集基础连接。

入门指南

本教程需要对Adobe Experience Platform的以下组件进行有效的理解:
  • 体验数据模型(XDM)系统 :组织客户体验数 Experience Platform 据的标准化框架。
    • 模式合成基础 :了解XDM模式的基本构件,包括模式构成的主要原则和最佳做法。
    • 模式注册开发人员指南 :包括成功执行对模式注册表API的调用时需要了解的重要信息。 这包括您 {TENANT_ID} 的、“容器”的概念以及发出请求所需的标题(特别要注意“接受”标题及其可能的值)。
  • 目录服务 :目录是数据位置和谱系的记录系统 Experience Platform。
  • 批量摄取 :批处理摄取API允许您将数据作为批处理文件引入Experience Platform。
  • 沙箱 : Experience Platform 提供将单个实例分为单独的虚 Platform 拟环境的虚拟沙箱,以帮助开发和发展数字体验应用程序。
以下各节提供您需要了解的其他信息,以便使用API成功连接到数据 Flow Service 湖。

读取示例API调用

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

收集所需标题的值

要调用API,您必 Platform 须先完成身份验证 教程 。 完成身份验证教程可为所有API调用中的每个所需 Experience Platform 标头提供值,如下所示:
  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
中的所有资 Experience Platform源(包括属于这些资 Flow Service源)都与特定虚拟沙箱隔离。 对API的 Platform 所有请求都需要一个标头,它指定操作将在中进行的沙箱的名称:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:
  • Content-Type: application/json

查找连接规范

创建数据集基础连接的第一步是从中检索一组连接规范 Flow Service。
API格式
每个可用源都有其自己的唯一连接规范集,用于描述连接器属性,如身份验证要求。 您可以通过执行GET请求和使用查询参数来查找数据集基础连接的连接规范。
发送不带GET参数的查询请求将返回所有可用源的连接规范。 您可以包含查询以 property=id=="c604ff05-7f1a-43c0-8e18-33bf874cb11c" 获取数据集基础连接的信息。
GET /connectionSpecs
GET /connectionSpecs?property=id=="c604ff05-7f1a-43c0-8e18-33bf874cb11c"

请求
以下请求检索数据集基础连接的连接规范。
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=id=="c604ff05-7f1a-43c0-8e18-33bf874cb11c"' \
    -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}'

响应
成功的响应会返回创建基本连接所需的连接规范 id 和唯一标识符()。
{
    "items": [
        {
            "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
            "name": "{NAME}",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "targetSpec": {
                "spec": {
                    "$schema": "http://json-schema.org/draft-07/schema#",
                    "type": "object",
                    "properties": {
                        "dataSetId": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "dataSetId"
                    ]
                }
            },
            "attributes": {
                "category": "{CATEGORY}"
            },
            "permissionsInfo": {
                "view": [
                    {
                        "@type": "lowLevel",
                        "name": "Dataset",
                        "permissions": [
                            "read"
                        ]
                    }
                ],
                "manage": [
                    {
                        "@type": "lowLevel",
                        "name": "Dataset",
                        "permissions": [
                            "write"
                        ]
                    }
                ]
            }
        }
    ]
}

创建数据集基础连接

基本连接指定源并包含该源的凭据。 只需一个数据集基础连接,因为它可用于创建多个源连接器以导入不同的数据。
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": "Dataset Base Connection",
        "description": "Dataset Base Connection",
        "connectionSpec": {
            "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
            "version": "1.0"
        }
    }'

属性
描述
connectionSpec.id
在上一步 id 中检索的连接规范。
响应
成功的响应会返回新创建的基本连接的详细信息,包括其唯一标识符( id )。 需要此ID才能创建目标连接并从第三方源连接器接收数据。
{
    "id": "d6c3988d-14ef-4000-8398-8d14ef000021",
    "etag": "\"d502e61b-0000-0200-0000-5e62a1f90000\""
}

后续步骤

通过本教程,您已使用API创建了数据集基连接 Flow Service ,并获得了连接的唯一ID值。 您可以使用此基本连接创建目标连接。 以下教程将逐步介绍创建目标连接的步骤,具体取决于您所使用的源连接器的类别: