ドキュメントExperience Platformソースコネクタガイド

Flow Service API を使用した Square ベース接続の作成

最終更新日： 2025年4月4日
  • トピック：

作成対象：

  • 開発者

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、Flow Service API を使用して、Square のベース接続を作成する手順を説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

  • ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Experience Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一のExperience Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示 Square ています。

必要な資格情報の収集

Flow Service を Square に接続するには、次の接続プロパティの値を指定する必要があります。

資格情報説明
hostSquare インスタンスの URL。
clientIdSquare アカウントに関連付けられたクライアント ID。
clientSecretSquare アカウントに関連付けられたクライアントの秘密鍵。
accessTokenアクセストークンは、OAuth 2.0 認証で Square アカウントを認証するために使用されます。 アクセストークンは Square から取得できます。
refreshToken更新トークンは、現在のアクセストークンの有効期限が切れた後に新しいアクセストークンを生成するために使用されます。 更新トークンは Square から取得できます。
connectionSpec.id接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。Square の接続仕様 ID は 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 です。

これらの資格情報とその取得方法について詳しくは、Square OAuth に関するドキュメントを参照してください。

Experience Platform API の使用

Experience Platform API を正常に呼び出す方法について詳しくは、Experience Platform API の概要を参照してください。

ベース接続の作成

ベース接続は、ソースとExperience 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
Square インスタンスの URL。
auth.params.clientId
Square アカウントに関連付けられたクライアント ID。
auth.params.clientSecret
Square アカウントに関連付けられたクライアントの秘密鍵。
auth.params.accessToken
アクセストークンは、OAuth 2.0 認証で Square アカウントを認証するために使用されます。 アクセストークンは 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\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Square 接続を作成し、接続の一意の ID 値を取得しました。 次のチュートリアルでは、この ID を使用した、Flow Service API を使用した支払い申請の調査方法を説明します。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089