通用 - 标准接口

认证授权机制

= 授权通道 + 授权令牌( api + token

目前平台支持多种登录方式(微信小程序、微信服务号、WAP网站等),在登录之后都会返回 token 和 有效时间。在获取到 token 值之后,需认证的接口都要传 token 值 和 api 授权通道。每个 api 授权通道同一时间内只能产生一个 token,也就是说一种终端只能登录一次。每个 token 对终端的 user-agent 信息绑定,更改后视为终端已经更换,token 则无效,需要重新使用新终端登录。

授权 name 值可以使用 getpostheader 三种方式提交(微信小程序对应值为 wxapp,微信服务号对应值为 wechatWAP 网站对应值为 wap,安卓App接口对应值为 android,苹果App接口对应值为 iosapp )。

授权 token 值可以使用 getpostheader 三种方式提交,从安全角度来说,建议使用 header 方式提交。

接口数据提交

目前平台只支持标准 form 表单方式提交数据,数据类型需要设置为:x-www-form-urlencoded。如果需要上传文件,可以使用 base64 方式上传,服务端再转存为文件,上传大文件建议直接对接云存储。

服务端接口响应 json 内容,内容固定三个字段 codeinfodata,其中 code 为状态码,info 为消息内容,data 为返回数据内容。

{
  "code": 0,
  "info": "接口返回提示消息",
  "data": {}
}

接口内置的返回状态码:

  1. 当接口状态码 code 返回 0 时,表示服务端业务执行失败,错误信息见 info 字段,数据见 data 字段。
  2. 当接口状态码 code 返回 1 时,表示服务端业务执行成功,提示信息见 info 字段,数据见 data 字段。
  3. 当接口状态码 code 返回 401 时,表示无效授权需要重新登录,错误信息见 info 字段,数据见 data 字段。
  4. 当接口状态码 code 返回 402 时,表示用户资料不全需要补录,错误信息见 info 字段,数据见 data 字段。
  5. 当接口状态码 code 返回 403 时,表示登录超时需要重新登录,错误信息见 info 字段,数据见 data 字段。
  6. 其他接口状态码 code 值可以根据实际情况定义,需要与接口客户端一起协商。

终端 javascript 请求示例

var xhr = new XMLHttpRequest();

xhr.setRequestHeader('Api-Name', 'wxapp');
xhr.setRequestHeader('Api-Token', '授权TOKEN');

xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');

xhr.open('post', 'https://v6.thinkadmin.top/data/api.data/getSlider', true);
xhr.send("username=USER&password=12356");

xhr.onload = function () {
    if (xhr.status === 200) {
        var text = xhr.responseText;
        var response = JSON.parse(text);
        console.log(response)
    } else {
        console.log(xhr)
    }
};

更多案例文档

ThinkAdmin 案例文档

Last Updated:
Contributors: 邹景立