API Reference · Base URL 与环境
晓葆开放平台 API 按调用场景分为两类:面向合作方后端的 S2S 签名接口(/open/v1/) 和面向用户端的 JWT 接口(/api/v1/)。
概述
平台提供沙箱与生产两套独立环境,数据完全隔离。 开发阶段全程使用沙箱;上线前完成应用审核后切换到生产 Base URL 即可。
Base URL
| 环境 | Base URL | 说明 |
|---|---|---|
| 沙箱 | https://sandbox-api.xiaobaotop.com | 用于开发调试,数据不影响生产,无需企业认证 |
| 生产 | https://api.xiaobaotop.com | 应用审核通过后方可使用 |
沙箱与生产共用同一套凭证体系,但 AppKey / AppSecret 不互通。 切换环境时需同步更换对应环境的凭证。
接口类型
| 前缀 | 类型 | 鉴权方式 | 适用场景 |
|---|---|---|---|
/open/v1/ | S2S 开放接口 | AppKey + MD5 签名(X-App-Id / X-Timestamp / X-Signature) | 合作方后端服务调用,用户互通 |
/api/v1/ | 用户端接口 | JWT Bearer Token(Authorization: Bearer <token>) | App 内功能调用,健康站预约、数据查询 |
详细鉴权说明请参考 鉴权说明。
统一响应格式
所有接口均返回统一的 JSON 结构:
// 成功响应
{
"success": true,
"code": 0,
"message": "操作成功",
"data": { ... },
"timestamp": "2026-04-01T10:00:00+08:00"
}
// 失败响应
{
"success": false,
"code": "ERROR_CODE",
"message": "错误描述",
"timestamp": "2026-04-01T10:00:00+08:00"
}
// 分页响应
{
"success": true,
"code": 0,
"data": [ ... ],
"meta": {
"current_page": 1,
"per_page": 20,
"total": 128,
"last_page": 7
},
"timestamp": "..."
}完整错误码列表见 错误码一览。