Generic OData接头为测试版。 有关使用测试版标签的连接器的详细信息,请参见源概述。
Flow Service 用于收集和集中Adobe Experience Platform内不同来源的客户数据。该服务提供用户界面和RESTful API,所有支持的源都可从中连接。
本教程使用Flow Service API指导您完成将Generic OData连接到Experience Platform的步骤。
本指南要求对Adobe Experience Platform的下列部分有工作上的理解:
以下各节提供了使用Flow Service API成功连接到OData所需了解的其他信息。
要使Flow Service与OData连接,必须为以下连接属性提供值:
凭据 | 描述 |
---|---|
url |
OData服务的根URL。 |
connectionSpec.id |
创建连接所需的唯一标识符。 OData的连接规范ID为:8e6b41a8-d998-4545-ad7d-c6a9fff406c3 |
有关入门的详细信息,请参阅此OData文档。
本教程提供示例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: {IMS_ORG}
Experience Platform中的所有资源(包括属于Flow Service的资源)都隔离到特定虚拟沙箱。 对Platform API的所有请求都需要一个标头,它指定操作将在以下位置进行的沙箱的名称:
x-sandbox-name: {SANDBOX_NAME}
所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:
Content-Type: application/json
连接指定源并包含该源的凭据。 每个OData帐户只需要一个连接,因为它可用于创建多个源连接器以导入不同的数据。
API格式
POST /connections
请求
要创建OData连接,其唯一连接规范ID必须作为POST请求的一部分提供。 OData的连接规范ID为8e6b41a8-d998-4545-ad7d-c6a9fff406c3
。
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Protocols",
"description": "A test connection for a Protocols source",
"auth": {
"specName": "Anonymous Authentication",
"params": {
"url" : "{URL}"
}
},
"connectionSpec": {
"id": "8e6b41a8-d998-4545-ad7d-c6a9fff406c3",
"version": "1.0"
}
}'
属性 | 描述 |
---|---|
auth.params.url |
OData服务器的主机。 |
connectionSpec.id |
OData连接规范ID:8e6b41a8-d998-4545-ad7d-c6a9fff406c3 。 |
响应
成功的响应会返回新创建的连接,包括其唯一连接标识符(id
)。 在下一个教程中浏览数据时需要此ID。
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
按照本教程,您已使用Flow Service API创建了OData连接,并已获得该连接的唯一ID值。 在下一个教程中,您可以使用此ID,因为您正在学习如何使用流服务API浏览协议应用程序。