> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kleep.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Magento

## 第一阶段：后端配置（OAuth1 API）

*此步骤允许 Kleep 获取您的产品目录、订单历史及退货数据，以校准算法。*

### 1. 创建 OAuth1 集成

1. 登录您的 **Magento 管理面板**。
2. 导航至 **系统 > 集成**。
3. 点击 **"添加新集成"**。
4. 填写 **名称** 字段（例如："Kleep Integration"）。
5. 输入您的 **管理员密码** 进行确认。

### 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. 点击 **"保存"** 创建集成。
2. 在新创建的集成上点击 **"激活"**。
3. 弹出窗口将显示您的 **OAuth 凭据**：
   * Consumer Key
   * Consumer Secret
   * Access Token
   * Access Token Secret
4. **复制这些凭据** —— 您需要将其发送给您的 Kleep 联系人。

有关创建和获取 Magento 2 API 凭据的指导，请参阅：

> [Subscribe Pro 教程：创建并获取 Magento 2 API 凭据](https://docs.subscribepro.com/integrations/magento-2/installation/step-3-magento-api-connection/)
> [Adobe 官方教程：Magento 2 OAuth 认证](https://developer.adobe.com/commerce/webapi/get-started/authentication/gs-authentication-oauth/)

### 4. 将凭据发送给 Kleep

请通过电子邮件将以下信息发送给您的 Kleep 联系人：

1. **请提供商店的完整 API 基础 URL。**
2. **OAuth1 凭据**
   * Consumer Key
   * Consumer Secret
   * Access Token
   * Access Token Secret

***

## 第二阶段：前端集成（Widget）

*此步骤涉及将 Kleep 脚本添加到您的产品页面（PDP），兼容所有版本的 Magento。*

请参阅我们的 [**JS Library Widget 指南**](/zh/cms/js-library)，在您的产品页面上安装和配置前端 CTA。

***

## 第三阶段：缺失数据管理（SFTP）

*当数据无法通过标准 API 端点获取时，本节适用。*

如果您的 Magento API 不允许获取退货数据或某些特定数据，我们将通过 CSV 文件交换方式进行处理。

请参阅以下文档，该指南将逐步引导您完成缺失数据的传输流程：

***

## **第四阶段：验证与生产部署**

### 1. 测试环境

首先在您的 **预生产/暂存** 环境中部署。

### 2. 视觉验证

上线前，请验证以下内容：

* 按钮是否正确显示？
* 点击是否能打开弹出窗口（Drawer）？
* 浏览器控制台中是否存在 "CORS" 错误？

### 3. 上线

经您和 Kleep 团队验证后，将修改部署到您的**生产**主题。---

## Cookie 与数据隐私

Kleep 完全受访客同意控制：脚本仅在通过您的 CMP 收集到同意**之后**才会加载，您必须相应地对其加载进行条件限制。有关追踪器完整列表、处理的数据、目的与法律依据、托管、分包处理方及安全信息，请参阅 [Cookie、CMP 与数据隐私](/zh/cookie-consent)。