获取token(内部)

简介

本文档主要针对HTTP API调用者,适用于内部系统H5端,对接前需向系统方获取客户端ID(client_id)、客户端密钥(client_secret)授权信息,web端通过用户名、密码获取token场景,调用业务API时需要在请求头中附带唯一会话access_token参数,access_token参数值同access_token值。 

· 获取token接口

返回唯一会话access_token值,请求API其他业务接口时附带会话值,例参数名/值:access_token/access_token。

请求URL: 

· http://IP:PORT/oauth/token

请求方式: 

· HTTP / POST

编码格式: 

· UTF-8

参数: 

请求参数header

参数名

必选

类型

说明

Content-Type

string

application/x-www-form-urlencoded或multipart/form-data 格式

Authorization

string

授权校验,格式为 Basic 空格base64(client_id:client_secret),测试可以通过 https://www.sojson.com/base64.html 在线编码获取

scope

string

以空格分隔的权限列表,若不传递此参数,代表请求默认的basic权限。(目前只有basic权限)。Access Token最终的访问范围,即用户实际授予的权限列表,用户在授权页面时,有可能会取消掉某些请求的权限,通常只作或只有登录认证的话,可忽略 。默认为all。

Accept

string

接受返回参数类型,默认为:/。例:application/json

Cache-Control

string

请求缓存,默认为:no-cache

请求参数Body 说明:以multipart/form-data或x-www-form-urlencoded方式提交

参数名

必选

类型

说明

grant_type

string

授权类型,默认为password

username

string

用户名

password

string

密码

返回示例

{

    "access_token": "eyJhbGci",

    "token_type": "bearer",

    "refresh_token": "Vqzi0Q0",

    "expires_in": 43199,

    "scope": "all",

    "userId": "a34d689f0d4e4658bfe69152aa4b2011",

    "username": "zj1001",

    "jti": "9cfa16aa-5e52-462d-b4a3-67c22eddd03a"

}

返回参数说明 响应body数据为JSON格式

参数名

类型

说明

access_token

String

唯一会话D,供业务接口会话校验使用

token_type

String

令牌类型“bearer”或“mac”,暂无很明确的说明,通常是brearer或省略

refresh_token

String

用于刷新Access Token 的 Refresh Token

expires_in

Int

token有效时长(秒),在有效时长内使用refresh_token刷新token或每次拉取最新的token

scope

String

Access Token最终的访问范围,即用户实际授予的权限列表,用户在授权页面时,有可能会取消掉某些请求的权限,通常只作或只有登录认证的话,可忽略

userId

String

用户ID

username

String

用户名

jti

String

可选的。token的唯一标识。


京ICP备16063819号-1