使用Flow Service API浏览电子商务连接

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

本教程使用Flow Service API来探索第三方​ 电子商务 ​连接。

快速入门

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

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

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

获取连接ID

要使用Platform API来探索您的​ 电子商务 ​连接,您必须拥有有效的连接ID。 如果您还没有要使用的​ 电子商务 ​连接,则可以通过以下教程创建一个连接:

正在读取示例 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: {ORG_ID}

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

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

浏览您的数据表

使用您的​ 电子商务 ​连接ID,您可以通过执行GET请求来浏览数据表。 使用以下调用查找要检查或纳入Platform的表的路径。

API格式

GET /connections/{CONNECTION_ID}/explore?objectType=root
参数
描述
{CONNECTION_ID}
您的​ 电子商务 ​连接ID。

请求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/582f4f8d-71e9-4a5c-a164-9d2056318d6c/explore?objectType=root' \
    -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}'

响应

成功的响应从​ 电子商务 ​连接返回表的数组。 查找要引入Platform的表并记下其path属性,因为您需要在下一步中提供该表以检查其结构。

[
    {
        "type": "table",
        "name": "Shopify.Abandoned_Checkout_Discount_Codes",
        "path": "Shopify.Abandoned_Checkout_Discount_Codes",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Shopify.Abandoned_Checkout_Line_Items",
        "path": "Shopify.Abandoned_Checkout_Line_Items",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Shopify.Blogs",
        "path": "Shopify.Blogs",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Shopify.Orders",
        "path": "Shopify.Orders",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表的结构

要从​ 电子商务 ​连接中检查表的结构,请在object查询参数中指定表的路径时执行GET请求。

API格式

GET /connections/{CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
参数
描述
{CONNECTION_ID}
您的​ 电子商务 ​连接的连接ID。
{TABLE_PATH}
电子商务 ​连接中表的路径。

请求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/582f4f8d-71e9-4a5c-a164-9d2056318d6c/explore?objectType=table&object=Orders' \
    -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}'

响应

成功的响应将返回指定表的结构。 有关每个表列的详细信息位于columns数组的元素中。

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Blog_Id",
                "type": "double",
                "xdm": {
                    "type": "number"
                }
            },
            {
                "name": "Title",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Created_At",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            {
                "name": "Tags",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    },
    "data": [
        {
            "Updated_At": "2020-11-05T10:54:36",
            "Title": "News",
            "Commentable": "no",
            "Blog_Id": 5.5458332804E10,
            "Handle": "news",
            "Created_At": "2020-02-14T09:11:15"
        }
    ]
}

后续步骤

通过学习本教程,您已探索您的​ 电子商务 ​连接,找到要摄取到Platform中的表的路径,并获取有关其结构的信息。 您可以在下一个教程中使用此信息,以收集电子商务数据并将其带入Platform

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089