使用Flow Service API浏览数据库

本教程使用Flow Service API来浏览第三方数据库的内容和文件结构。

快速入门

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

以下部分提供了使用Flow Service API成功连接到第三方数据库所需了解的其他信息。

收集所需的凭据

本教程要求您与要从中摄取数据的第三方数据库建立有效连接。 有效的连接涉及数据库的连接规范ID和连接ID。 有关创建数据库连接和检索这些值的详细信息，请参阅源连接器概述。

正在读取示例 API 调用

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

收集所需标头的值

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

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

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

浏览您的数据表

使用数据库的连接ID，可以通过执行GET请求来浏览数据表。 使用以下调用查找要检查或纳入Platform的表的路径。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

请求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/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": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表的结构

要从数据库中检查表的结构，请在将表的路径指定为查询参数时执行GET请求。

API格式

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

请求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/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": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

后续步骤

通过阅读本教程，您已浏览数据库，找到要摄取到Platform中的表的路径，并获取有关其结构的信息。 您可以在下一个教程中使用此信息从数据库收集数据并将其导入Platform。