OAuth2.0鉴权方式调用接口说明

安全接入方式说明

为保证API调用过程的安全可靠，e签宝开放平台openapi统一采用HTTPS传输协议，并提供了两种安全接入鉴权方式，开发者可根据自身情况任选一种方式。

方式一：OAuth2.0鉴权（不推荐使用）

OAuth2.0鉴权方式，采用标准的OAuth2.0 Client Credentials方式进行认证鉴权。

详见OAuth2.0鉴权方式调用接口说明

方式二：请求签名鉴权（优先推荐）

请求签名鉴权方式，采用对请求数据进行签名的方式实现安全接入，防止请求过程数据被篡改或盗用。

详见请求签名鉴权方式调用接口说明

OAuth2.0鉴权方式概述（不推荐使用）

OAuth 2.0 是目前比较流行的授权机制，用来授权第三方应用，获取接口调用权限。

e签宝服务端产生一个短期的接口调用令牌（Token），后续在令牌（Token）有效期内第三方应用可以通过Token获取接口调用权限。

e签宝将令牌（Token）统一描述为鉴权Token/授权码Token。

鉴权Token的获取方式

第三方应用申请授权码Token之前，需要先登录e签宝开放平台创建应用，应用创建成功后可以获取到身份识别信息：应用 ID（APP ID）和应用密钥（APP KEY）。

获取鉴权Token

接口描述

通过应用ID和应用密钥获取授权码Token，用来请求api接口。授权码Token有效时长为120分钟。

当授权码Token即将到期时需要调用接口重新获取授权码Token。旧授权码Token可以与新授权码Token共存5分钟，5分钟后旧授权码Token失效。

e签宝服务端允许开发者多次调用“获取鉴权Token”接口获取授权码Token。但只有最新获取的授权码Token的有效时长为120分钟。

举例：

连续获取100个授权码Token（T1，T2，……，T99，T100），此时T1-T98个Token属于失效Token无权调用接口。而T99个Token有效时长为5分钟，T100个Token有效时长为120分钟。

如果开发者同时有多台服务器调用api接口，建议使用集中存储方式保存授权码Token以确保授权码Token值的唯一。

接口地址

/v1/oauth2/access_token

请求方式

GET

请求参数

响应参数

展开全部参数参数名称		类型	必选	长度	参数说明	示例值
code		int	是		业务码，0表示成功
message		string	否		信息
data		object	否		业务信息
	token	string	否		授权码 注意：120分钟失效，请在expiresIn参数的有效截止时间失效前重新获取token，建议提前5分钟重新获取。
	expiresIn	string	否		有效截止时间（毫秒）
	refreshToken	string	否		刷新授权码

请求示例

{接口请求域名}/v1/oauth2/access_token?appId=111156XX41&secret=753b9XXXXXXXXXX3e3374c1&grantType=client_credentials

POSTMAN示例

响应参数

{
    "code":0,
    "message":"成功",
    "data":{
        "expiresIn":"1569211376807",
        "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJnSWQiOiI4N2I4YmJhNGY2N2U0ZjRiODQ3Njc2M2FmNTRjZGYxYSIsImFwcElkIjoiNDQzODc3MTgwOSIsIm9JZCI6ImJiZDNlYTExZWY0ZDQyNmI4NTYzNDhmYjg1MDYxM2ZmIiwidGltZXN0YW1wIjoxNTY5MjA0MTc2ODA2fQ.tiXdZeKPNWFrbt-i3fJfe8YiSIeouEIyt9i8TdQ85-Q",
        "refreshToken":"64924e629bc5923172dec8fca019fba9"
    }
}

电子签名 SaaS API 标准版其他接口调用方式

安全接入方式选择OAuth2.0鉴权方式时，每次调用电子签名 SaaS API 标准版中其他接口时需要在Header请求头中携带“X-Tsign-Open-Token”，传入授权码Token。

OAuth2.0鉴权方式-请求头

安全接入选择OAuth2.0鉴权方式，其请求头格式如下：

PostMan中示例如下：