跳到主要内容

开发文档

基于您自己的店铺进行开发

一套 REST API,与控制台使用同一份数据:商品、库存、订单、客户和付款,数据变化时通过 Webhook 通知。

预览

完整参考文档尚未公开。以下内容准确反映了当前已有的 API;访问权限按店铺申请开通。

快速上手

发出第一个请求前的三件事

01

创建店铺

API 以店铺为作用域。如果还没有店铺,可以先用免费套餐开一家。

创建店铺
02

申请权限

API 权限按店铺开通。请告诉我们店铺名称以及您要开发的内容。

申请权限
03

生成密钥

在控制台创建一个带权限范围的密钥,然后作为 Bearer 令牌发送。

查看认证机制

第一个请求

每次调用都由一个 Bearer 令牌和一个店铺作用域路径组成。响应为 JSON 格式,列表接口支持分页。

查看密钥、权限范围和限制
bash
curl https://api.securemarts.com/v1/products \
  -H "Authorization: Bearer $SECUREMARTS_API_KEY" \
  -H "Content-Type: application/json"

覆盖范围

API 覆盖的内容

与控制台读写的是同一份记录,而不是另存的一份报表数据副本。

商品目录与库存

读写商品、规格、商品集合及各门店库存。

订单与履约

查询订单、推进订单状态、关联配送并记录退货。

客户

客户档案、地址、订单历史及所属客户分组。

付款与发票

付款记录、发票、退款及相关单据。

Webhook

订阅订单、库存、付款和客户事件,所有推送内容均带签名。

网店数据

只读的商品目录和主题数据,用于搭建定制网店。

开发者常见问题

访问帮助中心

不是。API 权限取决于套餐,并按店铺开通。如果您的套餐包含该功能,可直接在控制台生成密钥;如不包含,可在价格页面了解升级方式。

参考文档公开时通知我