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

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

このチュートリアルでは、のベース接続を作成する手順を説明します。 Shopify （以下「」という。）Shopify」) Flow Service API.

はじめに

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

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

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

必要な資格情報の収集

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

資格情報 説明
host 次の項目のエンドポイント： Shopify サーバー。
accessToken のアクセストークン Shopify ユーザーアカウント。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Shopify の接続仕様 ID は 4f63aa36-bd48-4e33-bb83-49fbcd11c708 です。

導入の詳細については、 Shopify 認証ドキュメント.

Platform API の使用

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

ベース接続の作成

ベース接続は、ソースと Platform 間の情報（ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など）を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Shopify 認証資格情報をリクエストパラメーターの一部として使用します。

API 形式

POST /connections

リクエスト

次のリクエストは、Shopify のベース接続を作成します。

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": "Shopify source",
        "description": "Shopify source",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "host": "{HOST}",
                "accessToken": "{ACCESS_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "4f63aa36-bd48-4e33-bb83-49fbcd11c708",
            "version": "1.0"
        }
    }
プロパティ 説明
auth.params.host Shopify サーバーのエンドポイント。
auth.params.accessToken のアクセストークン Shopify ユーザーアカウント。
connectionSpec.id この Shopify 接続仕様 ID: 4f63aa36-bd48-4e33-bb83-49fbcd11c708.

応答

正常な応答は、新しく作成された接続を返します。この接続には、一意の接続識別子 (id) をクリックします。 この ID は、次のチュートリアルでデータを調べるために必要です。

{
    "id": "582f4f8d-71e9-4a5c-a164-9d2056318d6c",
    "etag": "\"d600d3ae-0000-0200-0000-5fa99a3d0000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Shopify ベース接続を作成しました。このベース接続 ID は、次のチュートリアルで使用できます。

このページ