Flow Service API を使用した Microsoft Dynamics ベース接続の作成

最終更新日: 2023-10-26
  • トピック:
  • Sources
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、のベース接続を作成する手順を説明します。 Microsoft Dynamics (以下「」という。)Dynamics」) を Flow Service API.

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

  • ソース:Experience Platform を使用すると、様々なソースからデータを取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

以下の節では、を使用して Platform を Dynamics アカウントに正常に接続するために知っておく必要がある追加情報を示します。 Flow Service API.

必要な資格情報の収集

Flow Service を Dynamics に接続するには、次の接続プロパティの値を指定する必要があります。

資格情報 説明
serviceUri のサービス URL Dynamics インスタンス。
username のユーザー名 Dynamics ユーザーアカウント。
password ユーザーのパスワード Dynamics アカウント。
資格情報 説明
servicePrincipalId のクライアント ID Dynamics アカウント。 この ID は、サービスプリンシパルとキーベースの認証を使用する場合に必要です。
servicePrincipalKey サービスプリンシパル秘密鍵です。 この資格情報は、サービスプリンシパルとキーベースの認証を使用する場合に必要です。

の導入について詳しくは、 この Dynamics 文書.

Platform API の使用

Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。

ベース接続の作成

ヒント

作成後は、 Dynamics ベース接続。 認証タイプを変更するには、新しいベース接続を作成する必要があります。

ベース接続は、ソースと Platform 間の情報(ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など)を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Dynamics 認証資格情報をリクエストパラメーターの一部として使用します。

の作成 Dynamics ベース接続

ヒント

作成後は、 Dynamics ベース接続。 認証タイプを変更するには、新しいベース接続を作成する必要があります。

ソース接続を作成する最初の手順は、Dynamics ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。

ベース接続 ID を作成するには、/connections エンドポイントに対して POST リクエストを実行し、その際に Dynamics 認証資格情報をリクエストパラメーターの一部として指定します。

API 形式

POST /connections

を作成するには、以下を実行します。 Dynamics 基本認証を使用したベース接続、 Flow Service 接続の serviceUri, username、および password.

 リクエスト
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: {ORG_ID}' \
    -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 インスタンス。
auth.params.username に関連付けられたユーザー名 Dynamics アカウント。
auth.params.password ユーザーに関連付けられたパスワード Dynamics アカウント。
connectionSpec.id Dynamics 接続仕様 ID:38ad80fe-8b06-4938-94f4-d4ee80266b07
 応答

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成された接続が応答として返されます。この ID は、次の手順で CRM システムを探索するために必要になります。

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

を作成するには、以下を実行します。 Dynamics サービスプリンシパルキーベースの認証を使用したベース接続で、 Flow Service 接続の serviceUri, servicePrincipalId、および servicePrincipalKey.

 リクエスト
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: {ORG_ID}' \
  -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 インスタンス。
auth.params.servicePrincipalId のクライアント ID Dynamics アカウント。 この ID は、サービスプリンシパルとキーベースの認証を使用する場合に必要です。
auth.params.servicePrincipalKey サービスプリンシパル秘密鍵です。 この資格情報は、サービスプリンシパルとキーベースの認証を使用する場合に必要です。
connectionSpec.id Dynamics 接続仕様 ID:38ad80fe-8b06-4938-94f4-d4ee80266b07
 応答

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成された接続が応答として返されます。この ID は、次の手順で CRM システムを探索するために必要になります。

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

次の手順

このチュートリアルでは、Flow Service API を使用して Microsoft Dynamics ベース接続を作成しました。このベース接続 ID は、次のチュートリアルで使用できます。

このページ