第一阶段:后端配置(OAuth1 API)
此步骤允许 Kleep 获取您的产品目录、订单历史及退货数据,以校准算法。1. 创建 OAuth1 集成
- 登录您的 Magento 管理面板。
- 导航至 系统 > 集成。
- 点击 “添加新集成”。
- 填写 名称 字段(例如:“Kleep Integration”)。
- 输入您的 管理员密码 进行确认。
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. 激活并获取凭据
- 点击 “保存” 创建集成。
- 在新创建的集成上点击 “激活”。
- 弹出窗口将显示您的 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
第二阶段:前端集成(Widget)
此步骤涉及将 Kleep 脚本添加到您的产品页面(PDP),兼容所有版本的 Magento。 请参阅我们的 JS Library Widget 指南,在您的产品页面上安装和配置前端 CTA。第三阶段:缺失数据管理(SFTP)
当数据无法通过标准 API 端点获取时,本节适用。 如果您的 Magento API 不允许获取退货数据或某些特定数据,我们将通过 CSV 文件交换方式进行处理。 请参阅以下文档,该指南将逐步引导您完成缺失数据的传输流程:第四阶段:验证与生产部署
1. 测试环境
首先在您的 预生产/暂存 环境中部署。2. 视觉验证
上线前,请验证以下内容:- 按钮是否正确显示?
- 点击是否能打开弹出窗口(Drawer)?
- 浏览器控制台中是否存在 “CORS” 错误?
