Flow Service API を使用した Microsoft Dynamics ベース接続の作成
Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。
このチュートリアルでは、Flow Service API を使用して Microsoft Dynamics （以下「Dynamics」）のベース接続を作成する手順について説明します。
はじめに
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
- ソース：Experience Platform を使用すると、様々なソースからデータを取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
- サンドボックス：Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
次の節では、Flow Service API を使用して Platform を Dynamics アカウントに正しく接続するために必要な追加情報を示します。
必要な資格情報の収集
Flow Service を Dynamics に接続するには、次の接続プロパティの値を指定する必要があります。
基本認証
| table 0-row-2 1-row-2 2-row-2 3-row-2 |
|
| 資格情報 |
説明 |
serviceUri |
Dynamics インスタンスのサービス URL。 |
username |
Dynamics ユーザーアカウントのユーザー名。 |
password |
Dynamics アカウントのパスワード。 |
サービスプリンシパルとキーの認証
| table 0-row-2 1-row-2 2-row-2 |
|
| 資格情報 |
説明 |
servicePrincipalId |
Dynamics アカウントのクライアント ID。 この ID は、サービスプリンシパルおよびキーベースの認証を使用する場合に必要です。 |
servicePrincipalKey |
サービスプリンシパルの秘密鍵。 この資格情報は、サービスプリンシパルおよびキーベースの認証を使用する場合に必要です。 |
基本について詳しくは、 このドキュメント Dynamics を参照してください。
Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。
ベース接続の作成
作成した後は、Dynamics ベース接続の認証タイプを変更できません。 認証タイプを変更するには、新しいベース接続を作成する必要があります。
ベース接続は、ソースと Platform 間の情報（ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など）を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。
ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Dynamics 認証資格情報をリクエストパラメーターの一部として使用します。
Dynamics ベース接続の作成
作成した後は、Dynamics ベース接続の認証タイプを変更できません。 認証タイプを変更するには、新しいベース接続を作成する必要があります。
ソース接続を作成する最初の手順は、Dynamics ソースを認証し、ベース接続 ID を生成することです。ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データのタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。
ベース接続 ID を作成するには、/connections エンドポイントに対して POST リクエストを実行し、その際に Dynamics 認証資格情報をリクエストパラメーターの一部として指定します。
API 形式
基本認証
基本認証を使用した Dynamics ベースPOSTを作成するには、Flow Service API に対して認証リクエストを行い、その際に接続の serviceUri、username、password の値を指定します。
| accordion |
| リクエスト |
| code language-shell |
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"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 |
|
| プロパティ |
説明 |
auth.params.serviceUri |
Dynamics インスタンスに関連付けられたサービス URI。 |
auth.params.username |
Dynamics アカウントに関連付けられたユーザー名。 |
auth.params.password |
Dynamics アカウントに関連付けられたパスワード。 |
connectionSpec.id |
Dynamics 接続仕様 ID：38ad80fe-8b06-4938-94f4-d4ee80266b07 |
|
| accordion |
| 応答 |
|
リクエストが成功した場合は、一意の ID（id）を含む、新しく作成された接続が応答として返されます。この ID は、次の手順で CRM システムを探索するために必要になります。
| code language-json |
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
|
|
サービスプリンシパルキーベースの認証
サービスプリンシパルキーベースの認証を使用して Dynamics ベースの接続を作成するには、Flow Service API にPOSTリクエストを行い、接続の serviceUri、servicePrincipalId、servicePrincipalKey の値を指定します。
| accordion |
| リクエスト |
| code language-shell |
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"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 |
|
| プロパティ |
説明 |
auth.params.serviceUri |
Dynamics インスタンスに関連付けられたサービス URI。 |
auth.params.servicePrincipalId |
Dynamics アカウントのクライアント ID。 この ID は、サービスプリンシパルおよびキーベースの認証を使用する場合に必要です。 |
auth.params.servicePrincipalKey |
サービスプリンシパルの秘密鍵。 この資格情報は、サービスプリンシパルおよびキーベースの認証を使用する場合に必要です。 |
connectionSpec.id |
Dynamics 接続仕様 ID：38ad80fe-8b06-4938-94f4-d4ee80266b07 |
|
| accordion |
| 応答 |
|
リクエストが成功した場合は、一意の ID（id）を含む、新しく作成された接続が応答として返されます。この ID は、次の手順で CRM システムを探索するために必要になります。
| code language-json |
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
|
|