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

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

このガイドでは、Flow Service APIを使用してShopify ソースコネクタのベース接続を作成する方法について説明します。

はじめに

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

  • Sources: ソースを使用すると、様々な外部システムやプラットフォームから簡単にデータを取り込むことができます。 この機能を利用すると、取り込むデータを整理、ラベル付け、拡充して、Experience Platform サービスを使用してより多くの価値を得ることができます。
  • Sandboxes: サンドボックスを使用すると、Experience Platform インスタンス内に個別のスペースを用意して、デジタルエクスペリエンスを安全にテスト、テスト、開発できるため、本番環境に影響を与えることなく変更を加えることができます。

必要な資格情報の収集

ベース接続を作成するには、有効なShopify認証情報が必要です。 必要な資格情報とその取得方法について詳しくは、Shopify ソースコネクタの概要を参照してください。

Experience Platform APIの使用

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

ベース接続の作成

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

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

API 形式

POST /connections

基本認証

次のリクエストは、基本認証を使用してShopifyのベース接続を作成します。

リクエスト
code language-shell
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"
      }
  }
table 0-row-2 1-row-2 2-row-2 3-row-2
プロパティ 説明
auth.params.host Shopify サーバーのエンドポイント。
auth.params.accessToken Shopify ユーザーアカウントのアクセストークン。
connectionSpec.id Shopify接続仕様ID: 4f63aa36-bd48-4e33-bb83-49fbcd11c708
応答

応答が成功すると、一意の接続識別子(id)を含む、新しく作成された接続が返されます。 このIDは、次のチュートリアルでデータを検索するために必要です。

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

トークンベースのアクセス

次のリクエストは、基本認証を使用してShopifyのベース接続を作成します。

リクエスト
code language-shell
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": "Create shopify v2 Test Connection",
    "description": "Connection creation for Shopify",
    "auth": {
      "specName": "Access Token Based",
      "params": {
        "host": "{HOST}",
        "accessToken": "{ACCESS_TOKEN}"
      }
    },
    "connectionSpec": {
      "id": "4f63aa36-bd48-4e33-bb83-49fbcd11c708",
      "version": "1.0"
    }
}'
table 0-row-2 1-row-2 2-row-2 3-row-2
プロパティ 説明
auth.params.host Shopify サーバーのエンドポイント。
auth.params.accessToken Shopify ユーザーアカウントのアクセストークン。
connectionSpec.id Shopify接続仕様ID: 4f63aa36-bd48-4e33-bb83-49fbcd11c708
応答

応答が成功すると、一意の接続識別子(id)を含む、新しく作成された接続が返されます。 このIDは、次のチュートリアルでデータを検索するために必要です。

code language-json
{
    "id": "92a00150-f3cc-4283-8fc4-6232725bcf33",
    "etag": "\"bb04d1f7-0000-0200-0000-69807e830000\""
}

次の手順

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

recommendation-more-help
experience-platform-help-sources