信多帮开放平台 API 文档
欢迎使用信多帮开放平台 API。本文档面向已开通开放接口能力的合作伙伴，提供 HTTP/JSON 接口说明与回调事件定义。
业务名词说明见 名词解释。
文档分 v2.0（现行，本页所属）与 v1.0。默认展示 v2.0；历史归档请通过站点右上角版本切换。
接入前提
- 需向信多帮申请开通 开放 API 功能，并获取
appid与secret。 - 测试环境请联系工作人员获取专用测试凭证。
基础信息
| 项目 | 说明 |
|---|---|
| 生产域名 | https://open.xinduobang.cn |
| 协议 | HTTPS |
| 数据格式 | JSON |
| 字符编码 | UTF-8 |
认证方式
除获取 Token 接口外，所有接口均需在请求中携带 token 参数。Token 通过 /api/getToken 接口获取，有效期为 7200 秒。
调用限制
- 单用户、单接口：每秒最多 5 次请求。
- 超出频率限制可能返回错误，请合理控制调用频率并实现重试退避。
通用响应格式
{
"code": 0,
"msg": "success",
"data": {}
}
| 字段 | 类型 | 说明 |
|---|---|---|
| code | int | 业务状态码，0 表示成功 |
| msg | string | 状态描述 |
| data | object / array | 业务数据，部分接口可能无此字段 |
快速开始
- 使用
appid和secret调用登录接口获取token。 - 在后续业务接口请求中携带
token。 - Token 过期前重新获取，避免业务中断。
回调通知
部分业务变更（订单、团组、会员、评价等）会以 HTTP POST 推送到友商配置的回调地址。接收成功请返回 HTTP 200。配置路径：后台 → 设置 → 开放平台 → 订阅事件。详见 回调通知概述。
文档导航
- 名词解释：营种、营期、会员、营员、规格、PLU 等常见概念
- 认证：获取访问令牌
- 营种 / 订单 / 营员 / 会员 / 营期 / 员工：核心业务接口
- 反馈 / 相册 / 媒体：辅助能力
- 扩展能力：适用于部分业务场景的补充接口（无相关场景可忽略）
- 回调通知：平台主动推送的事件（含 HTTPS 要求概述）
- 历史版本(不推荐)：v2.0 内不推荐的个别接口，新业务请勿使用
- 站点另有 v1.0 整站归档，请通过右上角版本切换；与侧栏「历史版本(不推荐)」不同