使用Flow Service API浏览付款系统

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

开发人员

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

本教程使用Flow Service API来浏览付款应用程序。

快速入门

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

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

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

收集所需的凭据

本教程要求您与希望从中摄取数据的第三方支付应用程序建立有效连接。有效的连接涉及应用程序的连接规范ID和连接ID。有关创建付款连接和检索这些值的详细信息，请参阅将付款源连接到Platform教程。

正在读取示例 API 调用

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

收集所需标头的值

要调用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)的请求都需要额外的媒体类型标头：

内容类型： 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/24151d58-ffa7-4960-951d-58ffa7396097/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": "PayPal.Billing_Plans",
        "path": "PayPal.Billing_Plans",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "PayPal.Billing_Plans_Payment_Definition",
        "path": "PayPal.Billing_Plans_Payment_Definition",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "PayPal.Billing_Plans_Payment_Definition_Charge_Models",
        "path": "PayPal.Billing_Plans_Payment_Definition_Charge_Models",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "PayPal.Catalog_Products",
        "path": "PayPal.Catalog_Products",
        "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/24151d58-ffa7-4960-951d-58ffa7396097/explore?objectType=table&object=test1.Mytable' \
    -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": "Product_Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Product_Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Description",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Type",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}

后续步骤

通过学习本教程，您已探索您的支付系统，找到要摄取到Platform中的表的路径，并获得了有关其结构的信息。您可以在下一个教程中使用此信息从付款系统收集数据并将其导入Platform。

recommendation-more-help

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