Flow Service APIを使用した決済システムの探索
Flow Serviceは、Adobe Experience Platform内の様々な異なるソースから顧客データを収集および一元化するために使用されます。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされているすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用して支払いアプリケーションを検索します。
はじめに
このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。
次の節では、Flow Service APIを使用して支払いアプリケーションに正常に接続するために知っておく必要がある追加情報を示します。
必要な資格情報の収集
ソースのファイルとファイル構造を調べるには、支払いアプリケーションとのアクティブな接続が必要です。 詳しくは、次のドキュメントを参照してください。
API 呼び出し例の読み取り
このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。 また、API レスポンスで返されるサンプル JSON も示されています。 ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーの値の収集
Experience Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。 次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
- Authorization: Bearer
{ACCESS_TOKEN} - x-api-key：
{API_KEY} - x-gw-ims-org-id：
{ORG_ID}
Flow Serviceに属するリソースを含む、Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されます。 Experience Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。
- x-sandbox-name：
{SANDBOX_NAME}
ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。
- Content-Type:
application/json
データテーブルの探索
支払いシステムの接続IDを使用すると、GET リクエストを実行してデータテーブルを調べることができます。 次の呼び出しを使用して、検査またはExperience Platformに取り込むテーブルのパスを見つけます。
API 形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
{BASE_CONNECTION_ID}リクエスト
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/24151d58-ffa7-4960-951d-58ffa7396097/explore?objectType=root' \
-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}'
応答
応答が成功すると、支払いシステムからテーブルの配列が返されます。 Experience Platformに取り込むテーブルを見つけ、そのpath プロパティをメモします。このプロパティは、次の手順で構造を検査するために必要です。
[
{
"type": "table",
"name": "Stripe.Billing_Plans",
"path": "Stripe.Billing_Plans",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Stripe.Billing_Plans_Payment_Definition",
"path": "Stripe.Billing_Plans_Payment_Definition",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Stripe.Billing_Plans_Payment_Definition_Charge_Models",
"path": "Stripe.Billing_Plans_Payment_Definition_Charge_Models",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Stripe.Catalog_Products",
"path": "Stripe.Catalog_Products",
"canPreview": true,
"canFetchSchema": true
}
]
テーブルの構造を調べる
支払いシステムからテーブルの構造を調べるには、テーブルのパスをクエリパラメーターとして指定しながらGET リクエストを実行します。
API 形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
{BASE_CONNECTION_ID}{TABLE_PATH}curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/24151d58-ffa7-4960-951d-58ffa7396097/explore?objectType=table&object=test1.Mytable' \
-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}'
応答
応答が成功すると、指定したテーブルの構造が返されます。 各テーブルの列に関する詳細は、columns配列の要素内にあります。
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Product_Id",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Product_Name",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Description",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Type",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
次の手順
このチュートリアルに従って、お客様は支払いシステムを調べ、Experience Platformに取り込むテーブルのパスを見つけ、その構造に関する情報を取得しました。 次のチュートリアルでこの情報を使用して、支払いシステムからデータを収集し、Experience Platformに取り込むことができます。