使用浏览协议系统 Flow Service API

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Sources

创建对象：

Developer

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

本教程使用 Flow Service 用于浏览协议应用程序的API。

快速入门

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

源： Experience Platform 允许从各种源摄取数据，同时让您能够使用以下方式构建、标记和增强传入数据： Platform 服务。
沙盒： Experience Platform 提供对单个进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中，以帮助开发和改进数字体验应用程序。

以下部分提供了成功连接到协议应用程序所需的其他信息 Flow Service API。

获取基本连接

为了使用探索您的协议系统 Platform API中，您必须拥有有效的基本连接ID。如果您还没有要使用的协议系统的基本连接，可以通过以下教程创建一个连接：

通用OData

正在读取示例API调用

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

收集所需标题的值

为了调用 Platform API，您必须先完成身份验证教程. 完成身份验证教程将提供所有中所有所需标头的值 Experience Platform API调用，如下所示：

授权：持有者 {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/{BASE_CONNECTION_ID}/explore?objectType=root

参数

描述

{BASE_CONNECTION_ID}

基于协议的连接的ID。

请求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/a5c6b647-e784-4b58-86b6-47e784ab580b/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": "Categories",
        "path": "Categories",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "CustomerDemographics",
        "path": "CustomerDemographics",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Customers",
        "path": "Customers",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Orders",
        "path": "Orders",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表的结构

要从协议应用程序检查表的结构，请在将表的路径指定为查询参数时执行GET请求。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

参数

描述

{BASE_CONNECTION_ID}

协议应用程序的连接ID。

{TABLE_PATH}

协议应用程序中表的路径。

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/a5c6b647-e784-4b58-86b6-47e784ab580b/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": "OrderID",
                "type": "integer",
                "xdm": {
                    "type": "integer",
                    "minimum": -2147483648,
                    "maximum": 2147483647
                }
            },
            {
                "name": "CustomerID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "EmployeeID",
                "type": "integer",
                "xdm": {
                    "type": "integer",
                    "minimum": -2147483648,
                    "maximum": 2147483647
                }
            },
            {
                "name": "OrderDate",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
        ]
    }
}

后续步骤

通过完成本教程，您已探索了协议应用，找到了要摄取的表的路径 Platform，并获得了有关其结构的信息。您可以在下一教程中使用此信息来从协议应用程序中收集数据并将其引入平台.

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089