使用流服务API创建Amazon Kinesis源连接

Flow Service 用于收集和集中来自Adobe Experience Platform内不同来源的客户数据。该服务提供用户界面和RESTful API,所有受支持的源都可从中连接。

本教程使用Flow Service API指导您完成将Experience Platform连接到Amazon Kinesis帐户的步骤。

入门指南

本指南要求对Adobe Experience Platform的以下组件有充分的了解:

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

以下各节提供了使用Flow Service API成功连接到Amazon Kinesis帐户所需了解的其他信息。

收集所需凭据

要使Flow Service与您的Amazon Kinesis帐户连接,必须为以下连接属性提供值:

凭据 描述
accessKeyId Kinesis帐户的访问密钥ID。
secretKey Kinesis帐户的密钥访问密钥。
region Kinesis帐户的区域。
connectionSpec.id Kinesis连接规范ID:86043421-563b-46ec-8e6c-e23184711bf6

有关这些值的详细信息,请参阅此Kinesis文档

读取示例API调用

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

收集所需标题的值

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

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有资源(包括属于Flow Service的资源)都隔离到特定虚拟沙箱。 对Platform API的所有请求都需要一个头,该头指定操作将在中执行的沙箱的名称:

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

创建连接

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

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": "Amazon Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region: "{REGION}
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.accessKeyId Kinesis帐户的访问密钥ID。
auth.params.secretKey Kinesis帐户的密钥访问密钥。
auth.params.region Kinesis帐户的区域。 有关区域的详细信息,请参阅IP地址允许列表上的文档
connectionSpec.id Kinesis连接规范ID:86043421-563b-46ec-8e6c-e23184711bf6

响应

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

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

后续步骤

通过本教程,您已使用API创建了Amazon Kinesis连接,并获取了作为响应体一部分的唯一ID。 您可以使用此连接ID来使用流服务API🔗收集流数据。

On this page