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

最終更新日： 2025年10月14日

トピック：
Sources

作成対象：

Developer

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

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

はじめに

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

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

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

必要な資格情報の収集

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

資格情報

説明

host

Square インスタンスのURL。

clientId

Square アカウントに関連付けられているクライアント ID。

clientSecret

Square アカウントに関連付けられているクライアントの秘密鍵。

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の概要に関するガイドを参照してください。

ベース接続の作成

ベース接続は、ソースの認証情報、接続の現在の状態、一意のベース接続IDなど、ソースとExperience Platform間の情報を保持します。ベース接続 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

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

experience-platform-help-sources