使用API调用连接到流目标并激活数据

注意

平台中的Amazon Kinesis和Azure Event Hubs目标当前处于测试状态。 文档和功能可能会发生变化。

本教程演示如何使用API调用连接到您的Adobe Experience Platform存储,创建到流云事件目标的连接(Amazon·KinesisAzure集线器),创建到新创建目标的数据流,以及将数据激活到新创建的目标。

本教程在所有示例中都使用Amazon Kinesis目标,但对于Azure Event Hubs,这些步骤是相同的。

概述——创建流目标和激活区段的步骤

如果您希望使用平台中的用户界面连接到目标并激活数据,请参阅连接目标将用户档案和区段激活到目标教程。

入门指南

本指南要求对Adobe Experience Platform的下列部分有工作上的理解:

  • Experience Data Model (XDM) System:Experience Platform组织客户体验数据的标准化框架。
  • Catalog Service: Catalog 是Experience Platform内数据位置和谱系的记录系统。
  • 沙箱:Experience Platform提供虚拟沙箱,将单个平台实例分为单独的虚拟环境,以帮助开发和发展数字体验应用程序。

以下各节提供您将需要了解的其他信息,以便将数据激活到平台中的流目标。

收集所需的凭据

要完成本教程中的步骤,您应准备好以下凭据,具体取决于要连接和激活区段的目标类型。

  • 对于Amazon Kinesis连接:accessKeyIdsecretKeyregionconnectionUrl
  • 对于Azure Event Hubs连接:sasKeyNamesasKeynamespace

读取示例API调用

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

收集必需和可选标头的值

要调用平台API,您必须先完成身份验证教程。 完成身份验证教程将提供所有Experience PlatformAPI调用中每个所需标头的值,如下所示:

  • 授权:载体{ACCESS_TOKEN}
  • x-api-key:{API_KEY}
  • x-gw-ims-org-id:{IMS_ORG}

Experience Platform中的资源可以隔离到特定虚拟沙箱。 在对平台API的请求中,您可以指定操作将在其中进行的沙箱的名称和ID。 这些是可选参数。

  • x-sandbox-name:{SANDBOX_NAME}
注意

有关Experience Platform中沙箱的详细信息,请参阅沙箱概述文档

所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:

  • Content-Type: application/json

Swagger文档

您可以在Swagger的本教程中找到所有API调用的随附参考文档。 请参阅Adobe.io](https://www.adobe.io/apis/experienceplatform/home/api-reference.html#!acpdr/swagger-specs/flow-service.yaml)上的[流服务API文档。 我们建议您同时使用本教程和Swagger文档页面。

获取可用流目标的列表

目标步骤概述步骤1

作为第一步,您应确定要激活数据的流目标。 首先,请执行呼叫以请求可连接和激活区段的可用目标列表。 对connectionSpecs端点执行以下GET请求以返回可用目标的列表:

API格式

GET /connectionSpecs

请求

curl --location --request GET 'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs' \
--header 'accept: application/json' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'

响应

成功的响应包含可用目标及其唯一标识符的列表(id)。 存储您计划使用的目标的值,这是后续步骤中需要的。 例如,如果要连接区段并将其传送到Amazon Kinesis或Azure Event Hubs,请在响应中查找以下代码片段:

{
    "id": "86043421-563b-46ec-8e6c-e23184711bf6",
  "name": "Amazon Kinesis",
  ...
  ...
}

{
    "id": "bf9f5905-92b7-48bf-bf20-455bc6b60a4e",
  "name": "Azure Event Hubs",
  ...
  ...
}

连接到Experience Platform数据

目标步骤概述步骤2

接下来,您必须连接到Experience Platform数据,以便导出用户档案数据并在首选目标中激活它。 这包括两个子步骤,如下所述。

  1. 首先,必须通过设置基本连接,在Experience Platform中执行授权访问数据的调用。
  2. 然后,使用基本连接ID,您将再次进行调用,在其中创建源连接,从而建立与Experience Platform数据的连接。

授权访问Experience Platform中的数据

API格式

POST /connections

请求

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name": "Base connection to Experience Platform",
            "description": "This call establishes the connection to Experience Platform data",
            "connectionSpec": {
                "id": "{CONNECTION_SPEC_ID}",
                "version": "1.0"
            }
}'
  • {CONNECTION_SPEC_ID}:使用统一用户档案服务的连接规范ID - 8a9c3494-9708-43d7-ae3f-cda01e5030e1

响应

成功的响应包含基连接的唯一标识符(id)。 在下一步创建源连接时,按需要存储此值。

{
    "id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}

连接到Experience Platform数据

API格式

POST /sourceConnections

请求

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name": "Connecting to Unified Profile Service",
            "description": "Optional",
            "connectionSpec": {
                "id": "{CONNECTION_SPEC_ID}",
                "version": "1.0"
            },
            "baseConnectionId": "{BASE_CONNECTION_ID}",
            "data": {
                "format": "json"
            },
            "params" : {}
}'
  • {BASE_CONNECTION_ID}:使用您在上一步中获得的ID。
  • {CONNECTION_SPEC_ID}:使用统一用户档案服务的连接规范ID - 8a9c3494-9708-43d7-ae3f-cda01e5030e1

响应

成功的响应会返回新创建的源连接到统一用户档案服务的唯一标识符(id)。 这将确认您已成功连接到Experience Platform数据。 在以后的步骤中存储此值。

{
    "id": "ed48ae9b-c774-4b6e-88ae-9bc7748b6e97"
}

连接到流目标

目标步骤概述步骤3

在此步骤中,您将设置到所需流目标的连接。 这包括两个子步骤,如下所述。

  1. 首先,必须通过设置基本连接来执行授权访问流目标的调用。
  2. 然后,使用基本连接ID,您将再次进行调用,在其中创建目标连接,该连接指定存储帐户中要传送导出数据的位置以及要导出的数据的格式。

授权访问流目标

API格式

POST /connections

请求

重要

以下示例包含前缀为//的代码注释。 这些注释突出显示不同流目标必须使用不同值的位置。 请在使用代码片断之前删除注释。

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/connections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Connection for Amazon Kinesis/ Azure Event Hubs",
    "description": "summer advertising campaign",
    "connectionSpec": {
        "id": "{_CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "auth": {
        "specName": "{AUTHENTICATION_CREDENTIALS}",
        "params": { // use these values for Amazon Kinesis connections
            "accessKeyId": "{ACCESS_ID}",
            "secretKey": "{SECRET_KEY}",
            "region": "{REGION}"
        },
        "params": { // use these values for Azure Event Hubs connections
            "sasKeyName": "{SAS_KEY_NAME}",
            "sasKey": "{SAS_KEY}",
            "namespace": "{EVENT_HUB_NAMESPACE}"
        }        
    }
}'
  • {CONNECTION_SPEC_ID}:使用您在获取可用目标的列表 步骤中获得的连接规范ID
  • {AUTHENTICATION_CREDENTIALS}:填写流目标的名称: Aws Kinesis authentication credentialsAzure EventHub authentication credentials
  • {ACCESS_ID}: 用于 Amazon Kinesis 连接。 您的AmazonKinesis存储位置的访问ID。
  • {SECRET_KEY}: 用于 Amazon Kinesis 连接。 你AmazonKinesis存储所的秘钥。
  • {REGION}: 用于 Amazon Kinesis 连接。 您帐户中平台 Amazon Kinesis 将流化您数据的区域。
  • {SAS_KEY_NAME}: 用于 Azure Event Hubs 连接。 填写您的SAS密钥名称。了解如何在Microsoft文档中使用SAS密钥对Azure Event Hubs进行身份验证。
  • {SAS_KEY}: 用于 Azure Event Hubs 连接。 填写您的SAS密钥。了解如何在Microsoft文档中使用SAS密钥对Azure Event Hubs进行身份验证。
  • {EVENT_HUB_NAMESPACE}: 用于 Azure Event Hubs 连接。 填写平台 Azure Event Hubs 在命名空间中将您的数据流化。有关详细信息,请参阅Microsoft文档中的创建事件集线器命名空间

响应

成功的响应包含基连接的唯一标识符(id)。 在下一步创建目标连接时,按需要存储此值。

{
    "id": "1ed86558-59b5-42f7-9865-5859b552f7f4"
}

指定存储位置和数据格式

API格式

POST /targetConnections

请求

重要

以下示例包含前缀为//的代码注释。 这些注释突出显示不同流目标必须使用不同值的位置。 请在使用代码片断之前删除注释。

curl --location --request POST 'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Amazon Kinesis/ Azure Event Hubs target connection",
    "description": "Connection to Amazon Kinesis/ Azure Event Hubs",
    "baseConnectionId": "{BASE_CONNECTION_ID}",
    "connectionSpec": {
        "id": "{CONNECTION_SPEC_ID}",
        "version": "1.0"
    },
    "data": {
        "format": "json"
    },
    "params": { // use these values for Amazon Kinesis connections
        "stream": "{NAME_OF_DATA_STREAM}", 
        "region": "{REGION}"
    },
    "params": { // use these values for Azure Event Hubs connections
        "eventHubName": "{EVENT_HUB_NAME}"
    }
}'
  • {BASE_CONNECTION_ID}:使用您在上述步骤中获得的基本连接ID。
  • {CONNECTION_SPEC_ID}:使用您在获取可用目标列表 步骤中获得的连接规范
  • {NAME_OF_DATA_STREAM}: 用于 Amazon Kinesis 连接。 在帐户中提供现有数据流的 Amazon Kinesis 名称。平台会将数据导出到此流。
  • {REGION}: 用于 Amazon Kinesis 连接。 您的AmazonKinesis帐户中的平台将流式传输您数据的区域。
  • {EVENT_HUB_NAME}: 用于 Azure Event Hubs 连接。 填写平台 Azure Event Hub 将在其中流式传输您的数据的名称。有关详细信息,请参阅Microsoft文档中的创建事件集线器

响应

成功的响应会返回新创建的目标到流目标的唯一标识符(id)。 按照后续步骤中的要求存储此值。

{
    "id": "12ab90c7-519c-4291-bd20-d64186b62da8"
}

创建数据流

目标步骤概述步骤4

现在,使用您在前面的步骤中获得的ID,您可以在Experience Platform数据和要激活数据的目标之间创建数据流。 将此步骤想象为构建Experience Platform和目标之间的管道,数据随后将通过管道流动。

要创建POST流,请执行如下所示的数据请求,同时在有效负荷中提供以下所述的值。

执行以下POST请求以创建数据流。

API格式

POST /flows

请求

curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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": "Azure Event Hubs",
  "description": "Azure Event Hubs",
  "flowSpec": {
    "id": "{FLOW_SPEC_ID}",
    "version": "1.0"
  },
  "sourceConnectionIds": [
    "{SOURCE_CONNECTION_ID}"
  ],
  "targetConnectionIds": [
    "{TARGET_CONNECTION_ID}"
  ],
  "transformations": [
    {
      "name": "GeneralTransform",
      "params": {
        "profileSelectors": {
          "selectors": [
            
          ]
        },
        "segmentSelectors": {
          "selectors": [
            
          ]
        }
      }
    }
  ]
}
  • {FLOW_SPEC_ID}:基于用户档案的目标的流规范ID是 71471eba-b620-49e4-90fd-23f1fa0174d8。在调用中使用此值。
  • {SOURCE_CONNECTION_ID}:使用在步骤Connect中获得的源连接 ID连接到Experience Platform
  • {TARGET_CONNECTION_ID}:使用您在步骤Connect中获得的目标连 接ID到流目标

响应

成功的响应会返回新创建的数据流的ID(id)和etag。 记下这两个值。 正如您在下一步中将其激活区段一样。

{
    "id": "8256cfb4-17e6-432c-a469-6aedafb16cd5",
    "etag": "8256cfb4-17e6-432c-a469-6aedafb16cd5"
}

将数据激活到新目标

目标步骤概述步骤5

创建了所有连接和数据流后,您现在可以将用户档案数据激活到流平台。 在此步骤中,您可以选择要发送到目标的区段和用户档案属性,还可以计划数据并将数据发送到目标。

要将区段激活到新目标,您必须执行JSONPATCH操作,如下例所示。 您可以在一次调用中激活多个段和用户档案属性。 要进一步了解JSONPATCH,请参阅RFC规范

API格式

PATCH /flows

请求

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--header 'If-Match: "{ETAG}"' \
--data-raw '[
  {
    "op": "add",
    "path": "/transformations/0/params/segmentSelectors/selectors/-",
    "value": {
      "type": "PLATFORM_SEGMENT",
      "value": {
        "name": "Name of the segment that you are activating",
        "description": "Description of the segment that you are activating",
        "id": "{SEGMENT_ID}"
      }
    }
  },
  {
    "op": "add",
    "path": "/transformations/0/params/profileSelectors/selectors/-",
    "value": {
      "type": "JSON_PATH",
      "value": {
        "operator": "EXISTS",
        "path": "{PROFILE_ATTRIBUTE}"
      }
    }
  }
]
  • {DATAFLOW_ID}:使用您在上一步中获得的数据流。
  • {ETAG}:使用您在上一步中获得的标签。
  • {SEGMENT_ID}:提供要导出到此目标的区段ID。要检索要激活的区段的区段ID,请转到​https://www.adobe.io/apis/experienceplatform/home/api-reference.html#/,在左侧导航菜单中选择​分段服务API,然后在​区段定义​中查找GET /segment/definitions操作。
  • {PROFILE_ATTRIBUTE}:例如, personalEmail.addressperson.lastName

响应

查找202 OK响应。 不返回响应主体。 要验证请求是否正确,请参阅下一步验证数据流。

验证数据流

目标步骤概述第6步

作为教程的最后一步,您应验证区段和用户档案属性确实已正确映射到数据流。

要验证此GET,请执行以下验证请求:

API格式

GET /flows

请求

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/flowservice/flows/{DATAFLOW_ID}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--header 'x-sandbox-name: prod' \
--header 'If-Match: "{ETAG}"' 
  • {DATAFLOW_ID}:使用上一步中的数据流。
  • {ETAG}:使用上一步中的标记。

响应

返回的响应应包含在transformations参数中您在上一步中提交的区段和用户档案属性。 响应中的示例transformations参数如下所示:

"transformations": [
    {
        "name": "GeneralTransform",
        "params": {
            "profileSelectors": {
                        "selectors": [
                            {
                                "type": "JSON_PATH",
                                "value": {
                                    "path": "personalEmail.address",
                                    "operator": "EXISTS"
                                }
                            },
                            {
                                "type": "JSON_PATH",
                                "value": {
                                    "path": "person.lastname",
                                    "operator": "EXISTS"
                                }
                            }
                        ]
                    },
            "segmentSelectors": {
                "selectors": [
                    {
                        "type": "PLATFORM_SEGMENT",
                        "value": {
                            "name": "Men over 50",
                            "description": "",
                            "id": "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02"
                        }
                    }
                ]
            }
        }
    }
],

导出的数据

重要

除了步骤将用户档案激活到新目标中的属性和区段外,AWS Kinesis和Azure Event Hubs中导出的数据还将包含有关标识映射的信息。 这表示导出用户档案的标识(例如ECID、移动ID、Google ID、电子邮件地址等)。 请参阅以下示例。

{
  "person": {
    "email": "yourstruly@adobe.con"
  },
  "segmentMembership": {
    "ups": {
      "72ddd79b-6b0a-4e97-a8d2-112ccd81bd02": {
        "lastQualificationTime": "2020-03-03T21:24:39Z",
        "status": "exited"
      },
      "7841ba61-23c1-4bb3-a495-00d695fe1e93": {
        "lastQualificationTime": "2020-03-04T23:37:33Z",
        "status": "existing"
      }
    }
  },
  "identityMap": {
    "ecid": [
      {
        "id": "14575006536349286404619648085736425115"
      },
      {
        "id": "66478888669296734530114754794777368480"
      }
    ],
    "email_lc_sha256": [
      {
        "id": "655332b5fa2aea4498bf7a290cff017cb4"
      },
      {
        "id": "66baf76ef9de8b42df8903f00e0e3dc0b7"
      }
    ]
  }
}

使用Postman集合连接到流目标

要以更简化的方式连接到本教程中介绍的流目标,您可以使用Postman

Postman 是一种工具,可用于进行API调用并管理预定义调用和环境的库。

对于此特定教程,已附加以下Postman集合:

  • AWS Kinesis Postman 集合
  • Azure Event Hubs Postman 集合

单击此处下载集合存档。

每个集合分别包含AWS Kinesis和Azure Event Hub所需的请求和环境变量。

如何使用邮递员集合

要使用附加的Postman集合成功连接到目标,请执行以下步骤:

  • 下载并安装Postman;
  • 下载 并解压缩附加的集合;
  • 将收藏集从其相应的文件夹导入邮递员;
  • 根据本文的说明填写环境变量;
  • 根据本文中的说明,运行来自邮递员的API请求。

后续步骤

通过遵循本教程,您已成功将平台连接到您的首选流目标之一并设置到相应目标的数据流。 传出数据现在可用于目标中进行客户分析或您希望执行的任何其他数据操作。 有关更多详细信息,请参阅以下页面:

在此页面上