フェーズ1:バックエンド設定(OAuth1 API)
このステップにより、Kleep はお客様の商品カタログ、注文履歴、返品データを取得してアルゴリズムを調整できます。1. OAuth1 インテグレーションの作成
- Magento 管理パネルにログインします。
- System > Integrations に移動します。
- 「Add New Integration」 をクリックします。
- Name フィールドに名前を入力します(例:「Kleep Integration」)。
- Admin Password を入力して確認します。
2. API 権限の設定
| ルート | 詳細 |
|---|---|
/products/* | すべての商品リソースへのアクセス |
/categories/* | すべてのカテゴリリソースへのアクセス |
/orders/* | すべての注文リソースへのアクセス |
/returns/* | すべての返品リソースへのアクセス |
/returnsAttributeMetadata/* | すべての返品属性リソースへのアクセス |
/returnsItemAttributeMetadata/* | すべての返品アイテム属性リソースへのアクセス |
/creditmemos/* | すべてのクレジットメモリソースへのアクセス |
/creditmemo/* | 単一クレジットメモリソースへのアクセス |
/stockItems/* | すべての在庫リソースへのアクセス |
/store/* | すべてのストアリソースへのアクセス |
/inventory/* | すべての在庫管理リソースへのアクセス |
/customers/* | すべての顧客リソースへのアクセス |
Magento_Catalog::productsMagento_Catalog::categoriesMagento_Sales::salesMagento_Sales::creditmemoMagento_Sales::actions_viewMagento_Rma::rmaMagento_Rma::magento_rmaMagento_Rma::rma_attributesVendor_Module::returnsMagento_CatalogInventory::cataloginventoryMagento_Store::storeMagento_Config::configMagento_Inventory::inventoryMagento_Customer::customer
- Magento インスタンスが追加の API レイヤーやカスタムエンドポイント(例:カスタム返品/RMA API)を公開している場合は、事前にご連絡ください。
- Magento API を経由しない外部返品プロバイダーを使用している場合は、返品データのドキュメントを参照するか、適切なインテグレーション方法についてご相談ください。
3. 資格情報の有効化と取得
- 「Save」 をクリックしてインテグレーションを作成します。
- 新しく作成したインテグレーションの 「Activate」 をクリックします。
- ポップアップに OAuth 認証情報 が表示されます:
- Consumer Key
- Consumer Secret
- Access Token
- Access Token Secret
- これらの資格情報をコピーして、Kleep 担当者にお送りください。
Subscribe Pro チュートリアル:Magento 2 API 資格情報の作成と取得 Adobe 公式チュートリアル:Magento 2 OAuth 認証
4. Kleep への資格情報の送付
以下の情報をメールで Kleep 担当者にお送りください:- ショップの完全な API ベース URL をご提供ください。
- 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」エラーが表示されないか?
