鉴权认证
一、鉴权认证机制
本文档主要针对HTTP API调用者,薪人薪事开放平台使用OAuth 2.0授权调用开放API。 调用之前使用appKey和appSecret通过凭证接口获取access_token信息,调用API时必须在请求中携带授权令牌 access_token 信息。
二、鉴权认证序列图:
以上为调用薪人薪事开放平台API的鉴权认证过程,请务必理解access_token的使用方式。
- 第1步为获取授权令牌;如未获取过令牌或access_token已过期,请在调用API之前先获取令牌信息。
- 第2步为开放平台根据客户的应用信息生成并返回授权令牌
- 第3步调用薪人薪事API,需携带access_token信息。
三、获取凭证令牌接口
接口说明:使用appKey和appSecret获取access_token,access_token的有效期为2小时。建议在本地缓存应用的凭证信息,避免频繁调用该接口。 为避免2小时到期出现临界点请求失败的情况,可在到期时间的前5分钟重新申请新的access_token,同时这5分钟以内旧的access_token任然有效,也可携带新的access_token访问。
请求方式:POST(HTTPS)
请求地址:https://api.xinrenxinshi.com/authorize/oauth/token?grant_type=client_credentials&client_secret=sE%25lU%25qLNhSy*kliM%23DO&client_id=appBqX8W4xucHImKCDffJ0Z3JxT8XB3O1
参数说明:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
grant_type | String | Y | 授权方式固定值:client_credentials |
client_id | String | Y | 应用appKey |
client_secret | String | Y | 应用appSecret |
返回结果:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
access_token | String | Y | 令牌 |
token_type | String | Y | 令牌类型 |
expires_in | String | Y | 有效时间 |
scope | String | Y | 授权作用域 |
响应示例:
{
"access_token": "715ad006-6ca5-4ab3-a910-0fca2752f000",
"token_type": "bearer",
"expires_in": 7199,
"scope": "OPENAPI"
}
异常示例:
如果返回以下异常请检查参数的正确性,并且发送请求之前使用UTF-8进行URLEncoding处理
{
"error": "invalid_client",
"error_description": "Bad client credentials"
}