Flow Service 用于从Adobe Experience Platform中各种不同的来源收集客户数据并对其进行集中。 该服务提供了一个用户界面和RESTful API,所有受支持的源均可从此API进行连接。
本教程使用 Flow Service 用于浏览CRM系统的API。
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
以下部分提供了成功连接到CRM系统所需的其他信息 Flow Service API。
为了使用探索您的CRM系统 Platform API,您必须拥有有效的连接ID。 如果您尚未与要使用的CRM系统建立连接,则可以通过以下教程创建一个连接:
本教程提供了示例API调用来演示如何设置请求的格式。 这些资源包括路径、必需的标头和格式正确的请求负载。 此外,还提供了在API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息,请参阅以下章节: 如何读取示例API调用 在 Experience Platform 疑难解答指南。
为了调用 Platform API,您必须先完成 身份验证教程. 完成身份验证教程将提供所有中所有所需标头的值 Experience 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
使用CRM系统的连接ID,您可以通过执行GET请求来浏览数据表。 使用以下调用查找要检查或摄取的表的路径 Platform.
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
参数 | 描述 |
---|---|
{BASE_CONNECTION_ID} |
CRM系统的基本连接的ID。 |
请求
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/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}'
响应
成功响应是指从到CRM系统的表数组。 查找您要引入的表 Platform 并注意其 path
属性,因为您需要在下一步中提供它以检查其结构。
[
{
"type": "table",
"name": "Solution Component Summary",
"path": "msdyn_solutioncomponentsummary",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Quote Invoicing Product",
"path": "msdyn_quoteinvoicingproduct",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Opportunity Relationship",
"path": "customeropportunityrole",
"canPreview": true,
"canFetchSchema": true
}
]
要从CRM系统中检查表的结构,请在将表的路径指定为查询参数时执行GET请求。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
参数 | 描述 |
---|---|
{BASE_CONNECTION_ID} |
CRM系统的基本连接的ID。 |
{TABLE_PATH} |
表的路径。 |
请求
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}' \
-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": "first_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "last_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "email",
"type": "string",
"meta": {
"originalType": "String"
}
}
]
}
}
通过学习本教程,您已探索您的CRM系统,找到要引入的表的路径 Platform,并获得了有关其结构的信息。 您可以在下一教程中使用此信息来 从您的CRM系统中收集数据并将其引入平台.