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に取り込むことができます。