建立 Square 基本連接使用 Flow Service API

基連接表示源和Adobe Experience Platform之間經過驗證的連接。

本教程將指導您完成建立基本連接的步驟 Square 使用 Flow Service API

快速入門

本指南要求對Adobe Experience Platform的下列組成部分有工作上的理解:

  • : Experience Platform 允許從各種源接收資料,同時讓您能夠使用 Platform 服務。
  • 沙箱: 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文檔

使用平台API

有關如何成功調用平台API的資訊,請參見上的指南 平台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值。 在學習如何 使用流服務API瀏覽付款應用程式

本頁內容