获取令牌
获取授权码
接口地址:/auth/code
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json
接口描述:
需要先在服务端调用这个接口获取授权码返回到客户端,然后客户端调用获取令牌接口。需要配置IP白名单,只能在添加在IP白名单的机器才能调用(这样是防止直接在客户端调用泄露密钥)
请求参数:
参数名称 | 参 数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
Authorization | 授权请求头,使用basic模式授权,格式为: Basic base64(clientId:clientSecret) | header | true | string | |
user_id | 用户ID | query | true | string | |
book_ids | 书籍ID列表,如果传入该参数在查词的时候只会查询传入的书籍 | query | false | array | string |
fields | 字段列表,如果传入该参数在查询内容的时候只会查询传入的字段 | query | false | array | string |
token_expires_in | 过期时间(秒),最大2591999(30天),最小60(1分钟) | query | false | integer(int64) |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | object |
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | 授权码 | string |
响应示例:
{
"code": ""
}
获取令牌
接口地址:/auth/token
请求方式:POST
请求数据类型:application/x-www-form-urlencoded
响应数据类型:application/json,application/problem+json
接口描述:
在客户端通过授权码获取令牌
如果是需要跨域,请把client_id参数写在问号的后面,去掉body里面的client_id参数,body里面只需要code参数就行,当然你也可以直接把code和client_id参数都放在query里面,例如:/token?client_id=您的clientId
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
code | 授权码,只能使用一次 | query | true | string | |
client_id | 客户端ID | query | true | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | 成功 | object |
401 | 授权失败 | object |
响应状态码-200:
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
token | 令牌 | string | |
expires_in | 过期时间(秒) | integer(int32) | integer(int32) |
token_type | 令牌类型 | string |
响应示例:
{
"token": "",
"expires_in": 0,
"token_type": "Bearer"
}
响应状态码-401:
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
type | 错误类型 | string | |
title | 标题 | string | |
status | 状态码 | integer(int32) | integer(int32) |
detail | 详细描述 | string | |
instance | 请求的路径 | string |
响应示例:
{
"type": "",
"title": "",
"status": 0,
"detail": "",
"instance": ""
}