使用Flow Service API建立Microsoft Dynamics來源連線

Flow Service 用於收集和集中Adobe Experience Platform內不同來源的客戶資料。該服務提供用戶介面和REST風格的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 document

讀取範例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連接,必須在POST請求中提供其唯一連接規範ID。 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)。 在下一步中探索您的CRM系統時,需要此ID。

{
    "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)。 在下一步中探索您的CRM系統時,需要此ID。

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

後續步驟

在本教程中,您使用Flow Service API建立了Dynamics連接,並獲取了該連接的唯一ID值。 您可在下一個教學課程中使用此ID,同時學習如何使用Flow Service API🔗來探索CRM系統。

本頁內容