中科图灵开放平台 / 智慧消防系统管理模块 / 登录获取token

登录获取token

接口描述: 登录获取token

HTTP/HTTPS
请求协议
GET
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
username字符串必须-用户名 示例admin
password字符串必须-密码 示例rKu1%2F348LvKp0rsVC06eCA%3D%3D
randomStr字符串必须-随机串 示例32281590387269204
code字符串必须-验证码 示例asdf
grant_type字符串必须-授权类型 示例password
scope字符串必须-授权范围 示例server
codeToken字符串必须-行为验证token 示例
authenticate字符串必须-前端从 verfiy 接口验证通过后,返回的参数 示例
tenantId字符串必须-站点id 示例
apiRequestRaw字符串可选-
headerInfo字符串必须-[{"headerName":"Authorization","headerValue":"Basic cGlnOnBpZw=="},{"headerName":"TENANT-ID","headerValue":"1"}]

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.access_token字符串访问token 令牌
data.token_type字符串
data.refresh_token字符串刷新token
data.expires_in字符串有效期 秒
data.scope字符串授权范围:server
data.tenant_id字符串租户id
data.license字符串许可
data.dept_id字符串所属单位id
data.user_id字符串用户id
data.username字符串用户名
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
username 必须
password 必须
randomStr 必须
code 必须
grant_type 必须
scope 必须
codeToken 必须
authenticate 必须
tenantId 必须
apiRequestRaw 可选
headerInfo 必须

客户端请求示例

成功响应返回示例:
{
    "access_token": "40be8832-0040-4769-91b1-edda4b79e811",
    "token_type": "bearer",
    "refresh_token": "bb7f14d2-5b7f-43e6-b5da-a98fe911dbde",
    "expires_in": 38891,
    "scope": "server",
    "tenant_id": 1,
    "license": "made by turingcloud",
    "dept_id": 1,
    "user_id": 1,
    "username": "admin"
}
失败响应返回示例:
codeToken和authenticate验证不通过

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
500表示服务端内部错误

本文档生成时间:2024-02-27 12:16:42