站点开放接口 · API v1

开放平台

用站点管理端生成的一对凭证，把站点里的商品、订单、会员记分与数字人民币等业务能力接入你自有的系统。 统一鉴权、统一返回结构：先用凭证换取 token，再以 Bearer token 调用业务接口。

快速开始查看接口清单
# 1) 用站点凭证换取 access_token
curl -X POST https://你的站点域名/open/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"appId": "nm1a2b3c4d5e6f7a8b", "appSecret": "9f8e7d6c..."}'

# 2) 携带 Bearer token 调用业务接口
curl https://你的站点域名/open/v1/site \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
接入准备

三步完成接入

凭证由站点管理端生成，第三方只需持有这一对值即可开始对接，无需再申请独立账号。

1

生成凭证

在站点管理端「系统管理 → 开放平台」点击「生成凭证」，得到该站点唯一的 appId 与 appSecret。

2

换取 token

调用 POST /open/v1/auth/token，用 appId + appSecret 换取 access_token。

3

调用业务接口

调用其余接口时携带 Authorization: Bearer {access_token}；token 过期后重新换取。

凭证按站点隔离：每个站点各自生成、互不通用；重置后旧凭证立即失效，请及时同步给已接入的第三方。

鉴权

获取 token

用站点凭证换取访问令牌。该接口是本页唯一不需要携带 token 的接口。

POST/open/v1/auth/token无需公共参数

请求参数

参数类型必填说明
appIdstring是站点管理端生成的应用 ID
appSecretstring是站点管理端生成的应用密钥

请求示例

curl -X POST https://你的站点域名/open/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "appId": "nm1a2b3c4d5e6f7a8b",
    "appSecret": "9f8e7d6c5b4a39281706f5e4d3c2b1a0..."
  }'

返回示例

{
  "code": 0,
  "message": "ok",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 7200
  },
  "request_id": "..."
}

access_token 是调用业务接口（见「接口清单」）的唯一鉴权凭证；appSecret 仅用于换取 token，不再随业务请求传输。

公共参数

每个接口都必须带上 Bearer token

除「获取 token」与行方回调外，所有开放接口都要求携带请求头 Authorization: Bearer {access_token}。缺失或无效 token 返回 401（业务码 10002）。

值请求头说明
access_tokenAuthorization: Bearer {access_token}POST /open/v1/auth/token 返回的访问令牌

站点由 token 中的站点 ID 识别（无需再传 siteId），token 与站点一一对应。

错误码

常见返回码

所有接口均返回统一结构 { code, message, data, request_id }，code = 0 表示成功。

code说明
0成功
10001参数错误
10002未登录或 token 失效（未携带或无效 access_token）
10005系统繁忙
20001站点不存在
20002站点已过期
20004站点已停用
30001应用凭证缺失（换取 token 时未传全 appId / appSecret）
30002应用凭证无效（appId / appSecret 不匹配或站点不可用）
30003数字人民币不可用（站点未接入或行方调用失败）
30004交易 / 退款单不存在
30005交易状态不允许该操作（如已支付交易关单、未支付交易退款、退款超额）
30006会员未绑定（第三方用户标识未绑定本站点会员）