跳到主要内容
版本:v2

获取令牌

获取授权码

接口地址:/auth/code

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json

接口描述:

需要先在服务端调用这个接口获取授权码返回到客户端,然后客户端调用获取令牌接口。需要配置IP白名单,只能在添加在IP白名单的机器才能调用(这样是防止直接在客户端调用泄露密钥)

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
Authorization授权请求头,使用basic模式授权,格式为: Basic base64(clientId:clientSecret)headertruestring
user_id用户IDquerytruestring
book_ids书籍ID列表,如果传入该参数在查词的时候只会查询传入的书籍queryfalsearraystring
fields字段列表,如果传入该参数在查询内容的时候只会查询传入的字段queryfalsearraystring
token_expires_in过期时间(秒),最大2591999(30天),最小60(1分钟)queryfalseinteger(int64)

响应状态:

状态码说明schema
200OKobject

响应参数:

参数名称参数说明类型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授权码,只能使用一次querytruestring
client_id客户端IDquerytruestring

响应状态:

状态码说明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": ""
}