Home

大家的Java博客OPEN-API文档

通用规则

地址格式：

为了方便，本文档所有地址将省略 "schema://host:port/" 这一部分。例如原地址为：

http://www.zuoxiaolong.com/example.html

那么在本文档中将会简写成如下形式：

/example.html

传参方式：

如接口文档内无特殊说明，则统一采用URL传参，比如：

username=zuoxiaolong&password=123456

用户登录管理：

用户注册接口和用户登录接口都会返回token，请将token进行管理。

在调用任何API接口时，需要添加一个header名称为“token”，值为用户注册接口和用户登录接口返回的token值来保持登录。

用户token更新：

出于安全考虑，移动端在用户每次启动应用时，应调用用户token登录接口登录。该接口会更新token值，并且在返回值中返回token，移动端应当在此时更新本地token。若token长期未使用，最长30天将会失效。

返回值统一格式：

为保持API清晰，服务端采用统一的数据返回格式，形式为JSON。如下：

{"code":200,"message":"操作成功","data":"该值根据接口返回值决定"}

code为200代表调用成功，否则代表调用发生错误。错误码的具体说明请参考错误码说明。

接口文档

接口名称	接口描述
用户注册接口	注册一个用户
用户登录接口	用户登录