主要用于公司内部产品线之间沟通,不提供给开放平台使用。

接口使用RESTful格式,在请求时需要注意正确的HTTP方法。
除某些特定接口外,所有接口调用都要携带身份验证信息。用户身份信息包括 auth_token、version_code、device。
可以通过HTTP请求参数带入,也可以将身份信息放到请求头的Authorization里,即在每个请求头中都加入如下参数:

Authorization: Token token="{{auth_token}}",version_code="{{version_code}}",device="{{device}}"

示例:

curl -X GET \
  /api/v2/ping
  -H 'Authorization: Token token=9b986abc0ff282823992f7c9f2c9bcc4, device=ios, version_code=3.20.0' \
  -H 'Content-Type: application/json;charset=utf-8'

验证信息参数解释

字段名 是否必填 描述
auth_token true 用户授权token
version_code true api版本号
device true 参照 device 参数列表
device 参数列表
device
h5 移动端
web pc端
miniprogram 小程序
open_api 开放接口
接口返回值说明:

正确结果示例:


   { "code": 0, "data": {} }

错误结果示例:


   { "code": 10000, "message": "" }

返回值说明

字段名 数据类型 描述
code int 返回代码,0 表示返回结果正常,其它值表示出错
message string 错误消息
data json 实际数据
文档更新时间: 2025-04-09 17:20   作者:李辉