鉴权认证
1. 获取鉴权Token
接口地址 /v1/oauth2/access_token
请求方式 GET
接口描述
通过appid和secrect请求api 授权码,用来请求业务api。如果有多台机器建议使用分布式存储,新旧token会共存5分钟。
请求参数:
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
appId | 应用id,需在e签宝开放平台创建 | query | true | string |
secret | 应用密钥,不可泄露 | query | true | string |
grantType | 授权类型,固定值: client_credentials | query | true | string |
请求示例
GET https://openapi.esign.cn/v1/oauth2/access_token?appId=1111563841&secret=753b9f6acafcbba300315838be3374c1&grantType=client_credentials
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
code | 业务码,0表示成功 | int32 |
data | 业务信息 | object |
token | 授权码 | string |
expiresIn | 有效截止时间(毫秒) | string |
refreshToken | 刷新授权码, 授权码token即将过期时需要用该刷新授权码获取新的token. | string |
message | 信息 | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"expiresIn":1560448943639,
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJnSWQiOiI4MzZhY2ZmM2EyOGE0NWMwYmE5NTcyNDc2YWNiYWY2OSIsImFwcElkIjoiMTExMTU2Mzg0MSIsIm9JZCI6IjQwZWI2MTcxNGQ5ZTQ5MDg4YmFjN2EzYzU2ZDY5ZDY2In0.gi27pijvwDR3xVVvaF66SfAOOjzZEE0HHXVM6V-QI_c",
"refreshToken":"5eeee3701c237621965691d4a39ed41e"
}
}
2. 刷新鉴权Token
接口地址 /v1/oauth2/refresh_token
请求方式 GET
接口描述
使用refresh token刷新授权码,在授权码过期前,通过refresh token获取新的授权码,新旧token会共存5分钟。
请求参数
参数名称 | 说明 | 参数类型 | 是否必填 | 类型 |
---|---|---|---|---|
appId | 应用id,需在e签宝开放平台创建 | query | true | string |
refreshToken | 用于刷新授权码的token | query | true | string |
grantType | 授权类型,固定值: refresh_token | query | true | string |
请求示例
GET https://openapi.esign.cn/v1/oauth2/refresh_token?appId=1111563841&grantType=refresh_token&refreshToken=5eeee3701c237621965691d4a39ed41e
响应参数
参数名称 | 说明 | 类型 |
---|---|---|
code | 业务码,0表示成功 | int32 |
data | 业务信息 | object |
token | 授权码 | string |
expiresIn | 有效截止时间(毫秒) | string |
refreshToken | 刷新授权码, 授权码token即将过期时需要用该刷新授权码获取新的token. | string |
message | 信息 | string |
响应示例
{
"code":0,
"message":"成功",
"data":{
"expiresIn":"1560449390364",
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJnSWQiOiI4MzZhY2ZmM2EyOGE0NWMwYmE5NTcyNDc2YWNiYWY2OSIsImFwcElkIjoiMTExMTU2Mzg0MSIsIm9JZCI6IjQwZWI2MTcxNGQ5ZTQ5MDg4YmFjN2EzYzU2ZDY5ZDY2In0.wrUP-RpEbj3R1-ykezVm5g4LPp_peKUOy065QBfWrmU",
"refreshToken":"98b99289c19722464832a6a48ed56aa8"
}
}