APIを使用して Microsoft DynamicsFlow Service コネクタを作成する

Flow Service は、Adobe Experience Platform内のさまざまな異なるソースから顧客データを収集し、一元化するために使用されます。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。

このチュートリアルでは、 Flow Service APIを使用して、CRMデータを収集するため Platform の Microsoft Dynamics (以下「Dynamics」と呼ばれる)アカウントに接続する手順を順を追って説明します。

でユーザインターフェイスを使用する場合は、 Experience PlatformDynamicsソースコネクタのUIチュートリアル で、同様の操作を実行するための手順を順を追って説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。

  • ソース: Experience Platform 様々なソースからデータを取り込むことができ、 Platform サービスを使用してデータの構造化、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス:Experience Platform は、1つのインスタンスを個別の仮想環境に分割し、デジタルエクスペリエンスのアプリケーションを開発および発展させる仮想 Platform サンドボックスを提供します。

The following sections provide additional information that you will need to know in order to successfully connect Platform to a Dynamics account using the Flow Service API.

必要な資格情報の収集

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

Credential 説明
serviceUri インスタンスのサービスURL Dynamics 。
username ユーザーアカウントのユー Dynamics ザー名です。
password アカウントのパス Dynamics ワード。

開始方法の詳細については、 このDynamicsドキュメントを参照してください

API 呼び出し例の読み取り

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

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

All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

接続仕様の検索

アカウント Platform に接続する前に、の接続仕様が存在することを確認する必要があり DynamicsDynamicsます。 接続仕様が存在しない場合は、接続を確立できません。

使用可能な各ソースには、認証要件などのコネクタプロパティを記述するための固有の接続仕様のセットがあります。 GETリクエストを実行し、クエリパラメーターを使用 Dynamics して、の接続仕様を検索できます。

API 形式

クエリパラメーターを指定しないでGETリクエストを送信すると、使用可能なすべてのソースの接続仕様が返されます。 特別な情報を取得す property=name=="dynamics-online" るクエリを含めることができ Dynamicsます。

GET /connectionSpecs
GET /connectionSpecs?property=name=="dynamics-online"

リクエスト

次のリクエストは、の接続仕様を取得し Dynamicsます。

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="dynamics-online"' \
    -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}'

応答

正常な応答は、固有な識別子( Dynamicsid)を含む、の接続仕様を返します。 このIDは、次の手順でベース接続を作成する際に必要となります。

{
    "items": [
        {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "name": "dynamics-online",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication for Dynamics-Online",
                    "settings": {
                        "authenticationType": "Office365",
                        "deploymentType": "Online"
                    },
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to dynamics-online",
                        "properties": {
                            "serviceUri": {
                                "type": "string",
                                "description": "The service URL of your Dynamics instance"
                            },
                            "username": {
                                "type": "string",
                                "description": "User name for the user account"
                            },
                            "password": {
                                "type": "string",
                                "description": "Password for the user account",
                                "format": "password"
                            }
                        },
                        "required": [
                            "username",
                            "password",
                            "serviceUri"
                        ]
                    }
                }
            ]
        }
    ]
}

API用の接続の作成

APIの接続は、ソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込むために複数のソースコネクタを作成するために使用できるので、APIは Dynamics アカウントごとに1つの接続のみ必要です。

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 Base Connection",
        "description": "Base connection for Dynamics account",
        "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 インスタンスに関連付けられているサービスURI Dynamics です。
auth.params.username アカウントに関連付けられているユー Dynamics ザ名。
auth.params.password アカウントに関連付けられているパス Dynamics ワードです。
connectionSpec.id 前の手順で取得 id した Dynamics アカウントの接続仕様。

応答

リクエストが成功した場合、ベース接続の一意の識別子(id)が返されます。このIDは、次のチュートリアルでデータを調べるために必要です。

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

次の手順

このチュートリアルに従うと、APIを使用して Dynamics アカウントへの接続が作成され、一意のIDが応答本文の一部として取得されます。 Flow Service APIを使用してCRMシステムを 調査する方法について学習する際に、次のチュートリアルでこの接続IDを使用できます

このページ