使用Flow Service API创建Microsoft Dynamics源连接

Flow Service 用于收集和集中Adobe Experience Platform内不同来源的客户数据。该服务提供用户界面和RESTful API,所有支持的源都可从中连接。

本教程使用Flow Service API指导您逐步使用Flow Service API将平台连接到Microsoft Dynamics(以下简称“Dynamics”)帐户。

入门指南

本指南要求对Adobe Experience Platform的下列部分有工作上的理解:

  • 来源:Experience Platform允许从各种来源摄取数据,同时使您能够使用平台服务来构建、标记和增强传入数据。
  • 沙箱:Experience Platform提供虚拟沙箱,将单个平台实例分为单独的虚拟环境,以帮助开发和发展数字体验应用程序。

以下各节提供了使用Flow Service API将平台成功连接到Dynamics帐户所需了解的其他信息。

收集所需的凭据

要使Flow Service连接到Dynamics,必须为以下连接属性提供值:

凭据 描述
serviceUri Dynamics实例的服务URL。
username Dynamics用户帐户的用户名。
password Dynamics帐户的口令。
servicePrincipalId Dynamics帐户的客户端ID。 使用服务主体和基于密钥的身份验证时需要此ID。
servicePrincipalKey 服务主密钥。 使用服务主体和基于密钥的身份验证时需要此凭据。

有关入门的详细信息,请访问this Dynamics 文档

读取示例API调用

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

收集所需标题的值

要调用平台API,您必须先完成身份验证教程。 完成身份验证教程将提供所有Experience PlatformAPI调用中每个所需标头的值,如下所示:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有资源(包括属于Flow Service的资源)都隔离到特定虚拟沙箱。 对平台API的所有请求都需要一个标头,它指定操作将在以下位置进行的沙箱的名称:

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

创建连接

连接指定源并包含该源的凭据。 每个Dynamics帐户只需要一个连接,因为它可用于创建多个数据流以引入不同的数据。

使用基本身份验证创建Dynamics连接

要使用基本身份验证创建Dynamics连接,请向Flow Service API发出POST请求,同时为连接的serviceUriusernamepassword提供值。

API格式

POST /connections

请求

要创建Dynamics连接,其唯一连接规范ID必须作为POST请求的一部分提供。 Dynamics的连接规范ID为38ad80fe-8b06-4938-94f4-d4ee80266b07

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": "Dynamics connection",
        "description": "Dynamics connection using basic auth",
        "auth": {
            "specName": "Basic Authentication for Dynamics-Online",
            "params": {
                "serviceUri": "{SERVICE_URI}",
                "username": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.serviceUri 与Dynamics实例关联的服务URI。
auth.params.username 与您的Dynamics帐户关联的用户名。
auth.params.password 与您的Dynamics帐户关联的密码。
connectionSpec.id 在上一步骤中检索的Dynamics帐户的连接规范id

响应

成功的响应会返回新创建的连接,包括其唯一标识符(id)。 需要此ID才能在下一步中浏览您的CRM系统。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

使用基于服务主体密钥的身份验证创建Dynamics连接

要使用基于服务主体密钥的身份验证创建Dynamics连接,请向Flow Service API发出POST请求,同时为连接的serviceUriservicePrincipalIdservicePrincipalKey提供值。

API格式

POST /connections

请求

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": "Dynamics connection",
        "description": "Dynamics connection using key-based authentication",
        "auth": {
            "specName": "Service Principal Key Based Authentication",
            "params": {
                "serviceUri": "{SERVICE_URI}",
                "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
            }
        },
        "connectionSpec": {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.serviceUri 与Dynamics实例关联的服务URI。
auth.params.servicePrincipalId Dynamics帐户的客户端ID。 使用服务主体和基于密钥的身份验证时需要此ID。
auth.params.servicePrincipalKey 服务主密钥。 使用服务主体和基于密钥的身份验证时需要此凭据。

响应

成功的响应会返回新创建的连接,包括其唯一标识符(id)。 需要此ID才能在下一步中浏览您的CRM系统。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

后续步骤

按照本教程,您已使用Flow Service API创建了Dynamics连接,并已获得该连接的唯一ID值。 在下一个教程中,您可以使用此ID,因为您正在学习如何使用流服务API浏览CRM系统。

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now