ベータ版

Shopify Streaming

最終更新日: 2023-10-31
  • トピック:
  • Sources
    このトピックの詳細を表示
  • 作成対象:
  • Developer
メモ

Shopify Streaming ソースはベータ版です。詳しくは、 ソースの概要 ベータラベル付きのソースの使用に関する詳細

Adobe Experience Platformは、ストリーミングアプリケーションからデータを取り込む機能を備えています。 ストリーミングプロバイダーのサポートには以下が含まれます。 Shopify.

前提条件

次の節では、を使用する前に完了する必要がある前提条件の手順について説明します。 Shopify Streaming ソース。

有効な Shopify に接続するためのパートナーアカウント Shopify API パートナーアカウントをまだお持ちでない場合は、 Shopify パートナーダッシュボード.

アプリケーションを作成する

有効な Shopify パートナーアカウントを使用する場合は、パートナーダッシュボードを使用して先に進み、アプリを作成できます。 でアプリを作成する方法に関する包括的な手順については、 Shopifyを読む Shopify はじめにのガイド.

アプリを作成したら、 クライアント ID および クライアント秘密鍵 から クライアント資格情報 タブ Shopify パートナーダッシュボード。 次の手順では、クライアント ID とクライアント秘密鍵を使用して、認証コードとアクセストークンを取得します。

認証コードの取得

次に、ドメインの myshopify.com ブラウザーへの URL。API キー、スコープ、リダイレクト URI を定義するクエリ文字列。

この URL の形式は次のとおりです。

API 形式

https://{SHOP}.myshopify.com/admin/oauth/authorize?client_id={API_KEY}&scope={SCOPES}&redirect_uri={REDIRECT_URI}
パラメーター 説明
shop サブドメイン myshopify.com URL。
api_key お使いの Shopify クライアント ID。 クライアント ID は、 クライアント資格情報 タブ Shopify パートナーダッシュボード。
scopes 定義するアクセスのタイプ。 たとえば、スコープを scope=write_orders,read_customers :オーダーの変更と顧客の読み取りの権限を許可します。
redirect_uri アクセストークンを生成するスクリプトの URL です。

リクエスト

https://connnectors-test.myshopify.com/admin/oauth/authorize?client_id=l6fiviermmzpram5i1spfub99shms3j9&scope=write_orders,read_customers&redirect_uri=https://acme.com

応答

リクエストが成功した場合は、アクセストークンの生成に必要な認証コードを含むリダイレクト URL が返されます。

https://www.acme.com/?code=k6j2palgrbljja228ou8c20fmn7w41gz&hmac=68c9163f772eecbc8848c90f695bca0460899c125af897a6d2b0ebbd59d3a43b&shop=connnectors-test.myshopify.com&state=123456×tamp=1658305460

アクセストークンの取得

これで、クライアント ID、クライアント秘密鍵、認証コードが揃い、アクセストークンを取得できます。 アクセストークンを取得するには、ドメインの myshopify.com この URL をに付加する際の URL Shopify’s API エンドポイント: /admin/oauth/access_token.

API 形式

POST /{SHOP}.myshopify.com/admin/oauth/access_token

リクエスト

次のリクエストを実行すると、 Shopify インスタンス。

curl -X POST \
  'https://connnectors-test.myshopify.com/admin/oauth/access_token' \
  -H 'developer-token: {DEVELOPER_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'Cookie: _master_udr=xxx; request_method=POST'
  -d '{
    "client_id": "l6fiviermmzpram5i1spfub99shms3j9",
    "client_secret": "dajn3caxz9s7ti624ncyv_m4f60jnwi3ii3y3k",
    "code": "k6j2palgrbljja228ou8c20fmn7w41gz"
}'

応答

正常な応答は、アクセストークンと権限範囲を返します。

{
  "access_token": "shpca_wjhifwfc91psjtldysxd6rqli371tx54",
  "scope": "write_orders,read_customers"
}

ストリーミング用の Webhook の作成 Shopify データ

Web フックを使用すると、アプリケーションとの同期を維持できます Shopify ショップで特定のイベントが発生した後に、データを取得したりアクションを実行したりします。 ストリーミング用 Shopify データをExperience Platformに送信する場合、Web フックを使用して、http エンドポイントとサブスクリプション用のトピックを定義できます。

リクエスト

次のリクエストを実行すると、 Shopify Streaming データ。

curl -X POST \
  'https://connnectors-test.myshopify.com/admin/api/2022-07/webhooks.json' \
  -H 'X-Shopify-Access-Token: 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' \
  -H 'Content-Type: application/json' \; request_method=POST' \
  -d '{
  "webhook": {
    "address": "https://dcs.adobedc.net/collection/9d411a24aa3c0a3eded92bac6c64d0da986ee7a8212f87168c5fb42d9ddc3227",
    "topic": "orders/create",
    "format": "json"
  }
}'
パラメーター 説明
webhook.address ストリーミングメッセージが送信される HTTP エンドポイント。
webhook.topic Webhook サブスクリプションのトピック。 詳しくは、 Shopify webhook イベントトピックガイド.
webhook.format データの形式。

応答

正常な応答は、Webhook に関する情報 ( 対応する id、アドレス、およびその他のメタデータ情報。

{
  "webhook": {
    "id": 1091138715786,
    "address": "https://dcs.adobedc.net/collection/9d411a24aa3c0a3eded92bac6c64d0da986ee7a8212f87168c5fb42d9ddc3227",
    "topic": "orders/create",
    "created_at": "2022-07-20T07:15:23-04:00",
    "updated_at": "2022-07-20T07:15:23-04:00",
    "format": "json",
    "fields": [],
    "metafield_namespaces": [],
    "api_version": "2021-10",
    "private_metafield_namespaces": []
  }
}

制限事項

以下は、 Shopify Streaming ソース。

  • 同じリソースに対して異なるトピックを配信する順序を調整できるかどうかは保証されません。 例えば、 products/update ウェブフックが配信される前に products/create Webhook.
  • Webhook イベントをエンドポイントに少なくとも 1 回配信するように Webhook を設定できます。 つまり、1 つのエンドポイントが同じイベントを複数回受け取る場合があります。 重複する Webhook イベントをスキャンするには、 X-Shopify-Webhook-Id ヘッダーから前のイベントへ。
  • Shopify は、HTTP 2xx ステータス応答を成功通知として処理します。 その他のステータスコードの応答は、失敗と見なされます。 Shopify には、失敗した Webhook 通知の再試行メカニズムが用意されています。 存在する場合 5 秒待った後の応答なし, Shopify 接続を再試行します 19 回 次の期間に 48 時間. 再試行期間の終わりまでに応答がない場合は、 Shopify ウェブフックを削除します。

次の手順

次のチュートリアルでは、 Shopify Streaming API と UI を使用してExperience Platformにソースを追加します。

このページ