接口说明

1.接口请求数据格式及说明

1.1 请求数据格式

{"param1":"xxx", "param2":"xxx",...}  


1.2 请求数据说明

接口统一使用JSONObject格式请求。


2.接口请求头说明

2.1 token说明

调用系统登录接口会返回一个token,除登录以外所有接口请求都需要携带该toekn【登录接口token为空字符串】,以便后台做登录身份认证。

示例:headers: {'token': token},

3.接口返回数据格式及说明

3.1 返回数据格式

{"result":{},"success":true,"code":"00000","message":"请求处理成功!"}


3.2 返回数据说明

名称 说明 备注 
 result接口返回数据;
如果没有数据则为null,如果登录失效则result为{};
如果接口有返回数据,那么只有当success为true且code为" 00000 "时,该字段有值,,特殊场景在接口中进行说明。
 
 success请求标识;
true为成功,false为失败;
 
 code接口处理返回结果码;
请求处理成功时为“00000”,其他表示请求处理失败。请求处理失败时message返回对应的提示消息。
 
 message 接口处理返回消息。 

3.3 如无特殊情况,接口返回数据说明中只说明result的返回数据


3.4 登录失效的返回结果码为03008;