基本連線代表來源和Adobe Experience Platform之間已驗證的連線。
本教學課程會逐步引導您完成建立基礎連線的步驟 Square 使用 Flow Service API.
本指南需要妥善了解下列Adobe Experience Platform元件:
以下各節提供您需要了解的其他資訊,以便成功連接到 Square 使用 Flow Service API。
為了 Flow Service 連線 Square,您必須提供下列連線屬性的值:
憑據 | 說明 |
---|---|
host |
的URL Square 例項。 |
clientId |
與您的 Square 帳戶。 |
clientSecret |
與您的 Square 帳戶。 |
accessToken |
存取權杖可用來驗證您的 Square 帳戶(驗證OAuth 2.0)。 存取權杖可從 Square. |
refreshToken |
當您目前的存取權杖過期時,會使用重新整理權杖來產生新的存取權杖。 可從取得重新整理代號 Square. |
connectionSpec.id |
連接規範返回源的連接器屬性,包括與建立基連接和源連接相關的驗證規範。 的連接規範ID Square 為: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 |
如需這些憑證以及如何取得的詳細資訊,請參閱 Square OAuth相關檔案.
如需如何成功呼叫Platform API的詳細資訊,請參閱 Platform API快速入門.
基本連接在源和平台之間保留資訊,包括源的驗證憑據、連接的當前狀態和唯一基本連接ID。 基本連線ID可讓您從來源探索和導覽檔案,並識別您要擷取的特定項目,包括其資料類型和格式的相關資訊。
若要建立基本連線ID,請向 /connections
端點提供 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 |
的URL Square 例項。 |
auth.params.clientId |
與您的 Square 帳戶。 |
auth.params.clientSecret |
與您的 Square 帳戶。 |
auth.params.accessToken |
存取權杖可用來驗證您的 Square 帳戶(驗證OAuth 2.0)。 存取權杖可從 Square. |
auth.params.refreshToken |
當您目前的存取權杖過期時,會使用重新整理權杖來產生新的存取權杖。 可從取得重新整理代號 Square. |
connectionSpec.id |
此 Square 連接規範ID: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 . |
回應
成功的回應會傳回新建立的連線,包括其唯一連線識別碼(id
)。 在下一個教學課程中探索資料時需要此ID。
{
"id": "24151d58-ffa7-4960-951d-58ffa7396097",
"etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}
依照本教學課程,您已建立 Square 使用 Flow Service API,並已取得連線的唯一ID值。 您可以在下一個教學課程中使用此ID,以了解如何 使用Flow Service API探索支付應用程式.