使用浏览数据库 Flow Service API
本教程使用 Flow Service 用于探索第三方数据库的内容和文件结构的API。
快速入门
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
以下部分提供了成功连接到第三方数据库所需的其他信息 Flow Service API。
收集所需的凭据
本教程要求您与要从中摄取数据的第三方数据库建立有效连接。 有效的连接涉及数据库的连接规范ID和连接ID。 有关创建数据库连接和检索这些值的详细信息,请参阅 源连接器概述.
正在读取示例API调用
本教程提供了示例API调用来演示如何设置请求的格式。 这些资源包括路径、必需的标头和格式正确的请求负载。 此外,还提供了在API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息,请参阅以下章节: 如何读取示例API调用 在 Experience Platform 疑难解答指南。
收集所需标题的值
为了调用 Platform API,您必须先完成 身份验证教程. 完成身份验证教程将在所有E中提供每个所需标头的值xperience 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/{BASE_CONNECTION_ID}/explore?objectType=root
{BASE_CONNECTION_ID}
请求
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}
{BASE_CONNECTION_ID}
{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.