Flow Service API を使用した Square ベース接続の作成
ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。
このチュートリアルでは、Flow Service API を使用して、Square のベース接続を作成する手順を説明します。
はじめに
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示 Square ています。
必要な資格情報の収集
Flow Service を Square に接続するには、次の接続プロパティの値を指定する必要があります。
host
clientId
clientSecret
accessToken
refreshToken
connectionSpec.id
2acf109f-9b66-4d5e-bc18-ebb2adcff8d5
です。これらの資格情報とその取得方法について詳しくは、Square OAuth に関するドキュメントを参照してください。
Platform API の使用
Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。
ベース接続の作成
ベース接続は、ソースと Platform 間の情報(ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など)を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。
ベース接続 ID を作成するには、/connections
エンドポイントに POST リクエストを実行し、Square 認証資格情報をリクエストパラメーターの一部として使用します。
API 形式
POST /connections
リクエスト
次のリクエストは、Square のベース接続を作成します。
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": "Square Base Connection",
"description": "Square Base Connection",
"auth": {
"specName": "OAuth2 Refresh Code",
"params": {
"host": "{HOST}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"accessToken": "{ACCESS_TOKEN}"
"refreshToken": "{REFRESH_TOKEN}"
}
},
"connectionSpec": {
"id": "2acf109f-9b66-4d5e-bc18-ebb2adcff8d5",
"version": "1.0"
}
}'
auth.params.host
auth.params.clientId
auth.params.clientSecret
auth.params.accessToken
auth.params.refreshToken
connectionSpec.id
2acf109f-9b66-4d5e-bc18-ebb2adcff8d5
。応答
応答が成功すると、一意の接続識別子(id
)を含む、新しく作成された接続が返されます。 この ID は、次のチュートリアルでデータを調べるために必要です。
{
"id": "24151d58-ffa7-4960-951d-58ffa7396097",
"etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}
次の手順
このチュートリアルでは、Flow Service API を使用して Square 接続を作成し、接続の一意の ID 値を取得しました。 次のチュートリアルでは、この ID を使用した、Flow Service API を使用した支払い申請の調査方法を説明します。