使用Flow Service API浏览CRM系统
Flow Service用于收集和集中Adobe Experience Platform中各种不同来源的客户数据。 该服务提供了一个用户界面和RESTful API,所有受支持的源均可从该API连接。
本教程使用Flow Service API来浏览CRM系统。
快速入门
本指南要求您对 Adobe Experience Platform 的以下组件有一定了解:
以下部分提供了使用Flow Service API成功连接到CRM系统所需的其他信息。
创建连接Id
要使用Platform API浏览您的CRM系统,您必须拥有有效的连接ID。 如果您尚未与要使用的CRM系统建立连接,则可通过以下教程创建一个连接:
正在读取示例 API 调用
本教程提供了示例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: {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}
请求
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系统向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
}
]
Inspect表的结构
要从CRM系统检查表的结构,请在将表的路径指定为查询参数时执行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/{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系统收集数据并将其带入Platform。