接口说明
请通读全文档,梳理调用顺序及每个字段的使用含义,如不明,请咨询万木侧支持。
# 使用方式
使用前第一件事是获取token,后面的操作均依赖token。平台会涉及几种token,请确认对接方案要使用的场景对接:
- api对接:api对接一般为appId+appSecret签名后获得的token,具体签名方式请查看对应接口的文档说明
- h5静默登录token:此场景为配合接入方嵌入万木h5页面到自己的产品,因万木h5页面均需登录后访问具体数据,为了前端跳过二次登录步骤,故需要接入方提前获取token在跳转时以参数方式传入页面
- 定制场景:定制开发的页面token获取,开发时对接
后续所有请求都需要设置header
header | 内容 |
---|---|
x-access-token | {token} |
Content-Type | application/json |
# 环境地址
- 测试环境:http://test.vanmul.com/vanmul-api/open-v1
- 正式环境:https://www.vanmul.com/vanmul-api/open-v1
【老环境说明】 因万木健康架构和安全策略升级,原测试环境http://www.vanmul.com:10086/vanmul-api/dev/open-v1将于2023年09月13日停止解析,请尽快切换至上述环境,给您带来不便,敬请谅解! 如有任何问题欢迎微信联系:vinsonQQ
# 统一响应
平台统一响应报文如下:
字段 | 类型 | 说明 |
---|---|---|
code | int | 响应成功:1 ,其他需酌情处理 |
msg | string | 响应说明 |
success | boolean | true/false |
data | T | 业务数据 |
# 返回示例
{
"code": 1,
"msg": "操作成功!",
"success": true,
"data": {
"id": "202215",
"doctorId": "97809c389ffd4dad4a5f",
"name": "张三",
"avatar": "http://xxxx",
"mobile": "13388556655",
"createTime":"2023-05-14 19:20:17"
}
}
# 注意事项
- 对接口返回的数据,调用方请保存相关数据和状态
- 接口请设置最大超时时间,建议为3s以内
- 如有轮训类场景,请设置最大超时时间和合理轮训间隔。请求结束后,万木侧不存储请求的信息和状态,需要接入方自行维护
上次更新: 2023/09/06, 02:25:09