Show Menu
トピック×

Flow Service APIを使用してMicrosoft Dynamics Connectorを作成する

フローサービスは、Adobe Experience Platform内の様々な異なるソースから顧客データを収集し、一元管理するために使用します。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用して、CRMデータを収集するためのMicrosoft Dynamics(以下「Dynamics」と呼ばれる)アカウントにプラットフォームを接続する手順を説明します。
Experience Platformでユーザーインターフェイスを使用したい場合は、 DynamicsソースコネクタのUIチュートリアル (英語のみ)で、同様の操作を実行するための手順を順を追って説明します。

はじめに

このガイドでは、Adobe Experience Platformの次のコンポーネントについて、十分に理解している必要があります。
  • ソース : Experience Platformを使用すると、様々なソースからデータを取り込むと同時に、プラットフォームサービスを使用して、入力データの構造、ラベル付け、拡張を行うことができます。
  • サンドボックス : Experience Platformは、1つのプラットフォームインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。
Flow Service APIを使用してPlatformをDynamicsアカウントに正しく接続するために必要な追加情報については、以下の節で説明します。

必要な資格情報の収集

フローサービスがDynamicsに接続するには、次の接続プロパティの値を指定する必要があります。
Credential
説明
serviceUri
DynamicsインスタンスのサービスURL。
username
Dynamicsユーザーアカウントのユーザー名です。
password
Dynamicsアカウントのパスワードです。
開始方法の詳細については、 このDynamicsドキュメントを参照してください

サンプルAPI呼び出しの読み取り

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

必要なヘッダーの値の収集

プラットフォームAPIを呼び出すには、まず 認証チュートリアルを完了する必要があります 。 次に示すように、認証チュートリアルで、すべてのExperience Platform API呼び出しに必要な各ヘッダーの値を指定します。
  • 認証: 無記名 {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

接続仕様の検索

PlatformをDynamicsアカウントに接続する前に、Dynamicsの接続仕様が存在することを確認する必要があります。 接続仕様が存在しない場合は、接続を確立できません。
使用可能な各ソースには、認証要件などのコネクタプロパティを記述するための固有の接続仕様のセットがあります。 GET要求を実行し、クエリパラメータを使用して、Dynamicsの接続仕様を検索できます。
API形式
クエリパラメータを指定せずにGET要求を送信すると、使用可能なすべてのソースの接続仕様が返されます。 クエリを含めて、Dynamics専用 property=name=="dynamics-online" の情報を取得できます。
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}'

応答
正常な応答は、固有な識別子( id )を含むDynamicsの接続仕様を返します。 この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"
                        ]
                    }
                }
            ]
        }
    ]
}

ベース接続を作成する

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

リクエスト
curl -X POST \
    'http://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
Dynamicsインスタンスに関連付けられているサービスURIです。
auth.params.username
Dynamicsアカウントに関連付けられているユーザー名です。
auth.params.password
Dynamicsアカウントに関連付けられているパスワードです。
connectionSpec.id
前の手順で取得したDynamicsアカウント id の接続指定です。
応答
成功した応答には、ベース接続の固有な識別子( id )が含まれます。 このIDは、次のチュートリアルでデータを調べるために必要です。
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

次の手順

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