Genstore REST API

Genstore 提供了一套功能强大的 REST APIs，允许开发者通过编程方式扩展平台的功能，并与其他系统进行交互和数据同步。

使用 REST API 要求

• HTTP REST 规范：所有 API 调用均遵守 HTTP REST 标准。
• 响应状态码：遵循标准 HTTP 状态码来指示每个请求的成功或失败。
• 请求速率限制：为防止 API 滥用，所有请求都受到速率限制。
• 授权认证：访问 API 需要有效的授权认证信息。
• 版本管理：Genstore API 将定期更新版本，以引入新功能和改进。

路径与请求

通过标准 HTTP 方法与 REST API 通信。以下是基本请求的 URI 结构和方法示例：

基本 URI

https://{shop}.genmystore.ai/api/202410/{resource}.json

请求方法

• POST：创建资源（非幂等）
• PUT：更新资源（幂等）
• DEL：删除资源
• GET：检索资源信息

响应状态码

当 Genstore 接收到 REST API 请求时，会根据处理结果在响应中返回不同的 HTTP 状态码。例如：200 OK，表示 REST API 请求处理成功。
关于 Genstore 响应状态码的更多信息，可查看 响应状态码

API 速率限制

我们使用令牌桶算法来管理 API 请求速率，具体机制如下：

• 初始桶大小：每个应用在每个店铺的令牌桶起始含有 40 个令牌。
• 令牌消耗：每发出一个请求，将消耗一个令牌。
• 令牌恢复：当令牌数量少于 40 个时，系统以每秒 2 个令牌的速率自动补充，直至令牌桶再次满额。
• 处理超限请求：若令牌桶中令牌耗尽至 0 个，再有新的请求到来时，则返回状态码 429（请求过多），以提示速率限制已达上限。

WARNING

请严格遵守 API 速率限制，确保服务的可靠性，严格禁止在面向客户的应用中使用 API，以免因速率限制导致服务中断。

关于速率限制的更多内容，可查看 API 速率限制

访问范围与权限

应用必须在安装时声明所需的访问范围并获得商户授权，才能访问特定的 API。此外，一些特殊的 API（如访问所有订单数据或受保护字段等）可能需要额外向 Genstore 申请并获得批准。

• 常规访问：应用在商户安装时声明访问范围，经商户授权后，方可访问相应的 API。
• 特殊访问：对于高敏感性或功能性强的 API，开发者需向 Genstore 提交详细申请，经批准后方可使用。
  关于访问范围与权限的更多内容，可查看 访问范围

版本管理

Genstore Rest API 会定期发布新版本来响应业务需求的变化，您可以在请求中指定所需的版本，当前默认版本 202412。

关于版本管理的更多内容，可查看 版本管理