メインコンテンツへスキップ

フェーズ1:バックエンド設定(OAuth1 API)

このステップにより、Kleep はお客様の商品カタログ、注文履歴、返品データを取得してアルゴリズムを調整できます。

1. OAuth1 インテグレーションの作成

  1. Magento 管理パネルにログインします。
  2. System > Integrations に移動します。
  3. 「Add New Integration」 をクリックします。
  4. Name フィールドに名前を入力します(例:「Kleep Integration」)。
  5. Admin Password を入力して確認します。

2. API 権限の設定

ルート詳細
/products/*すべての商品リソースへのアクセス
/categories/*すべてのカテゴリリソースへのアクセス
/orders/*すべての注文リソースへのアクセス
/returns/*すべての返品リソースへのアクセス
/returnsAttributeMetadata/*すべての返品属性リソースへのアクセス
/returnsItemAttributeMetadata/*すべての返品アイテム属性リソースへのアクセス
/creditmemos/*すべてのクレジットメモリソースへのアクセス
/creditmemo/*単一クレジットメモリソースへのアクセス
/stockItems/*すべての在庫リソースへのアクセス
/store/*すべてのストアリソースへのアクセス
/inventory/*すべての在庫管理リソースへのアクセス
/customers/*すべての顧客リソースへのアクセス
Magento の以下の ACL に対応する必要があります
  • Magento_Catalog::products
  • Magento_Catalog::categories
  • Magento_Sales::sales
  • Magento_Sales::creditmemo
  • Magento_Sales::actions_view
  • Magento_Rma::rma
  • Magento_Rma::magento_rma
  • Magento_Rma::rma_attributes
  • Vendor_Module::returns
  • Magento_CatalogInventory::cataloginventory
  • Magento_Store::store
  • Magento_Config::config
  • Magento_Inventory::inventory
  • Magento_Customer::customer
⚠️ 重要:
  • Magento インスタンスが追加の API レイヤーやカスタムエンドポイント(例:カスタム返品/RMA API)を公開している場合は、事前にご連絡ください。
  • Magento API を経由しない外部返品プロバイダーを使用している場合は、返品データのドキュメントを参照するか、適切なインテグレーション方法についてご相談ください。

3. 資格情報の有効化と取得

  1. 「Save」 をクリックしてインテグレーションを作成します。
  2. 新しく作成したインテグレーションの 「Activate」 をクリックします。
  3. ポップアップに OAuth 認証情報 が表示されます:
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret
  4. これらの資格情報をコピーして、Kleep 担当者にお送りください。
Magento 2 API 資格情報の作成と取得に関するガイダンスについては、以下を参照してください:
Subscribe Pro チュートリアル:Magento 2 API 資格情報の作成と取得 Adobe 公式チュートリアル:Magento 2 OAuth 認証

4. Kleep への資格情報の送付

以下の情報をメールで Kleep 担当者にお送りください:
  1. ショップの完全な API ベース URL をご提供ください。
  2. OAuth1 認証情報
    • Consumer Key
    • Consumer Secret
    • Access Token
    • Access Token Secret

フェーズ2:フロントエンドインテグレーション(ウィジェット)

このステップでは、商品ページ(PDP)に Kleep スクリプトを追加します。Magento の全バージョンに対応しています。 JS ライブラリ ウィジェットガイドに従って、商品ページのフロントエンド CTA をインストールおよび設定してください。

フェーズ3:不足データの管理(SFTP)

このセクションは、標準 API エンドポイントからデータを取得できない場合に適用されます。 Magento API で返品データや特定のデータを取得できない場合は、CSV ファイル交換で対応します。 以下のドキュメントをご参照ください。不足データの送信プロセスをステップごとに説明しています:

フェーズ4:検証と本番環境へのデプロイ

1. テスト環境

まず プリプロダクション/ステージング 環境にデプロイしてください。

2. ビジュアル確認

本番公開前に以下を確認してください:
  • ボタンが正しく表示されているか?
  • クリックするとポップアップ(Drawer)が開くか?
  • ブラウザコンソールに「CORS」エラーが表示されないか?

3. 本番公開

お客様と Kleep チームの両方による確認が完了したら、Production テーマに変更をデプロイしてください。---

クッキーとデータプライバシー

Kleep は訪問者の同意によって完全に制御されています。スクリプトは CMP を通じて同意が収集された後にのみロードされ、それに応じてロードを条件付けする必要があります。トラッカーの完全なリスト、処理されるデータ、目的と法的根拠、ホスティング、サブプロセッサー、セキュリティについては、クッキー、CMP とデータプライバシーをご参照ください。