用户工具

站点工具


wiki:v_interface_regauth

1.获取API_TOKEN

 (1).接口调用请求说明

请求方式POST

请求路径:{authServerUrl} /api/1.0/auth/getToken

请求参数:

参数

必填\选填

类型

描述

appkey

必填

string

24位应用码

masterSecret

必填

string

30位主密钥

返回参数:

参数

名称

类型

备注

code

返回码

string

 

message

提示语

string

 

data

返回数据

objec

 

apiToken

API调用凭证

string

UUID

示例:

示例地址:http://xf.tandatech.com:8081/login/api/1.0/auth/getToken

body:

{

    "appkey": "xxxxxxxxxxxxxxxxxxxxxxxx",

    "masterSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

}

示例结果:

{

    "code": "000000",

    "message": "认证成功",

    "data": {

        "apiToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

}

错误时平台会返回错误码等信息

返回码说明

返回码

描述

000000

请求成功

P01000

输入参数错误

L02100

appkey无效

L02201

appkeymasterSecret不匹配

2.检测Token有效状态

 (1).接口调用请求说明

请求方式POST

请求路径:{authServerUrl} /api/1.0/auth/checkToken

请求参数:无需参数

返回参数:

参数

名称

类型

备注

code

返回码

string

 

message

提示语

string

 

示例:

示例地址:http://xf.tandatech.com:8081/login/api/1.0/auth/getToken

示例结果:

{

    "code": "000000",

    "message": "认证成功"

}

错误时平台会返回错误码等信息

返回码说明

返回码

描述

000000

认证有效

L03001

认证失效

3.注销

 (1).接口调用请求说明

请求方式GET

请求路径:{authServerUrl} /api/1.0/auth/logoutToken

请求参数:无需参数

返回参数:

参数

名称

类型

备注

code

返回码

string

 

message

提示语

string

 

示例地址:

示例地址:http://xf.tandatech.com:8081/login/api/1.0/auth/getToken

body:

{

    "appkey": "xxxxxxxxxxxxxxxxxxxxxxxx",

    "masterSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

}

示例结果:

{

    "code": "000000",

    "message": "注销成功"

}

wiki/v_interface_regauth.txt · 最后更改: 2018/05/10 17:18 由 admin