访问范围
在使用 REST API 访问 Genstore 店铺数据之前,所有应用都必须声明所需的访问范围,并经过商家的授权才能访问相应的店铺数据。本文将介绍如何声明和指定合理的访问范围。
访问范围
访问范围 | 方式 | 描述 |
---|---|---|
业务域访问范围 | 应用声明指定 | 控制应用访问特定业务域数据,只有在声明并授权后,应用才可以访问相关 REST API。默认情况下,订单域只返回最近 60 天的订单数据,并过滤所有保护字段数据。 |
所有订单数据范围 | 申请审核通过 | 需要在合作伙伴平台申请并通过审核,才能访问完整订单数据,包括 60 天前的订单数据。 |
保护字段范围 | 申请审核通过 | 需要在合作伙伴平台申请并通过审核,才能访问包含敏感数据(如姓名、邮箱等)的保护字段。 |
业务域访问范围
在应用开发过程中,应用必须声明其所需访问的业务域范围。以下是各个业务域访问范围的说明。
TIP
建议根据应用需求,合理选择访问范围,避免申请过多权限,影响安装使用。
范围 | 读写 | 访问范围描述 |
---|---|---|
read_all_orders | 只读 | 可查询所有订单,包含 60 天以前的订单。需在合作伙伴平台的应用控制台申请。 |
read_orders | 只读 | 可查询最近 60 天订单,如需查询 60 天前订单,需额外申请 read_all_orders 权限。 |
write_orders | 读写 | 可管理订单,包含创建、更新、删除、查询操作。如需查询 60 天前订单,需额外申请 read_all_orders 权限。 |
read_products | 只读 | 可查询所有产品信息。 |
write_products | 读写 | 可管理产品,包含创建、更新、删除、查询等操作 |
read_shops | 只读 | 可查询商店数据 |
write_shops | 读写 | 可管理商店数据 |
read_refunds | 只读 | 可查询退货单 |
write_refunds | 读写 | 可管理退货单 |
read_customers | 只读 | 可查询客户,隐私保护字段查询需要在合作伙伴平台的应用控制台申请 |
write_customers | 读写 | 可管理客户, 包含创建、更新、删除、查询等操作 |
read_discounts | 只读 | 可查询折扣信息 |
write_discounts | 读写 | 可管理折扣 |
read_gift_card | 只读 | 可查询礼品卡信息 |
write_gift_card | 读写 | 可管理礼品卡 |
read_apps | 只读 | 可查询应用信息,包括授权范围,消息订阅信息,应用信息等 |
write_apps | 读写 | 可管理应用,包括授权范围,消息订阅信息,应用信息等 |
read_fulfillments | 只读 | 可查询订单履约信息 |
write_fulfillments | 读写 | 可管理订单履约 |
read_market | 只读 | 可查询市场信息 |
write_market | 读写 | 可管理市场 |
read_finance_account | 只读 | 可查询账务账号信息 |
write_finance_account | 读写 | 可管理账务账号 |
read_payments_transaction | 只读 | 可查询支付交易订单 |
write_payments_transaction | 读写 | 可管理支付交易订单 |
待补充 | 读写 | … |
订单数据范围
默认情况下,REST API 的订单数据仅限获取最近 60 天的订单数据。如果需要访问超过 60 天的订单数据,应用必须申请读取所有订单数据,并通过平台审核后,才能访问完整的订单数据。
申请访问完整订单数据
进入合作伙伴平台的应用控制台 :
- 点击 API 访问权限 -> 数据访问请求 -> 读取所有订单数据,点击申请访问权限按钮。
- 在权限申请表单页,填写权限申请表单,说明申请理由,提交工单。
- 平台收到申请后,将会进行审核。
保护字段范围
为了保护商家和客户的隐私数据,某些敏感的客户信息(如姓名、邮箱、手机等)需要申请额外的权限,并通过平台审核,应用才能访问这些保护字段。
TIP
请注意,以上限制仅适用于商家店铺。在应用开发阶段,您只需提交保护字段范围的申请,即可访问测试店铺的保护字段,无需等待审批。
保护字段
保护字段涉及的个人信息包括:
- 姓名:包括姓、名、全名
- 邮箱:用户的邮箱地址
- 手机:用户的手机号
- 地址:用户的地址
申请访问保护字段
进入合作伙伴平台的应用控制台 :
- 点击 API 访问权限 -> 数据访问请求 -> 受保护的客户数据,点击申请访问权限按钮。
- 在权限申请表单页,勾选需访问的保护字段,说明申请理由,提交工单。
- 平台收到申请后,将会进行审核。
TIP
建议根据应用需求,合理选择访问范围,避免申请过多权限,影响安装使用。