接口描述
开发者获取到授权码code后,需要通过应用ID和应用密钥获取访问令牌token和刷新令牌refreshToken,用于后续用户资源的访问。访问令牌Token有效时长为120分钟。
刷新令牌refreshToken用于刷新访问令牌token的有效期。刷新令牌refreshToken有效期为30天。
30天内可重复使用此刷新令牌refreshToken来刷新获取新的访问令牌token,免除用户的重复授权,30天后,需用户再次进行授权并获取访问令牌token。
接口地址
/v2/oauth2/access_token
请求方式
POST
请求头
参数名称 | 类型 | 必选 | 参数说明 |
X-Tsign-Open-App-Id | string | 是 | 应用ID,通过e签宝开放平台获取。 |
X-Tsign-Open-Authorization-Version | string | 是 | 授权版本号,请填写固定值 v2 |
Content-Type | string | 是 | 数据提交类型,请填写固定值 application/x-www-form-urlencoded |
请求参数
参数名称 | 类型 | 必选 | 参数类型 | 参数说明 |
appId | string | 是 | body | 应用id。通过开放平台的应用创建获取 |
secret | string | 是 | body | 应用的秘钥。通过开放平台对应的应用配置里获取AppKey。 |
grantType | string | 是 | body | 当前授权类型,请填写固定值 authorization_code |
redirectUri | string | 是 | body | 授权的重定向地址,需要跟发起授权时指定的地址一致。 |
code | string | 是 | body | 授权码code。 code有效期为30天。 code在有效期内,只能换取一次token,换取后code立即失效,失效后的code无法继续使用。 |
请求示例
POST https://smlopenapi.esign.cn/v2/oauth2/access_token
响应参数
展开全部参数参数名称 | 类型 | 必选 | 参数说明 | |
code | int | 是 | 业务码,0表示成功 | |
message | string | 否 | 信息 | |
data | object | 否 | 业务信息 | |
token | string | 是 | token访问令牌。 | |
expiresIn | string | 是 | token访问令牌失效时间,有效期120分钟,时间戳格式,单位毫秒。 如:1635436800857 | |
refreshToken | string | 是 | refreshToken刷新令牌。可用于在30天内获取新的token访问令牌。 |
响应示例
{ "code": 0, "message": "成功", "data": { "expiresIn": "1596346168704", "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRob3JpemVyIjoiZTVmMGJkMDY5YzYzNDk3OGJjM2M1MjIwYWVhMWI4ZWEiLCJhcHBJZCI6IjM4NzY1NDM5OTYiLCJzY29wZSI6ImdldF91c2VyX2luZm8iL...", "refreshToken": "2083c2f9e95df2317fd4208150a08083" } }
授权码code获取说明
方式一:用户授权认证完成后,开发者可通过重定向地址(页面)获取到当前code授权码。
方式二:用户授权认证完成后,开发者可以通过授权认证回调通知获取到当前code授权码。
Tips:
1、开发者需要在用户授权完成后触发重定向地址的请求时,进行接收授权码code,以便后续换取授权令牌token;并根据实际业务场景的需要,重定向到签署页面或者三方的定制页。
2、code有效期为10分钟,超过有效期,即使code没有使用过,也无法再次使用。
3、code在有效期内,只能换取一次token,换取后code立即失效,失效后的code无法继续使用。