接口调用说明
本文档主要讲解接口调用过程中的重要步骤
一、接口访问流程
- 通过应用appKey和appSecret获取授权令牌access_token(详见:鉴权认证 )
调用方调用薪人薪事API,需携带access_token信息;参数传递策略如下:
<1>. 调用业务接口,请在HTTP Header中携带授权令牌 access_token 信息。 <2>. 调用免登跳转接口,请直接将access_token 信息设置到请求参数中。
请求参数需经过签名计算出签名值,并在参数中传递sign信息
- 调用方发送请求之前使用UTF-8进行URLEncoding处理,然后调用API
- 接收并解析API返回结果
二、公共参数说明
- 请统一用HTTPS(基于TLS1.2安全协议)、JSON数据格式(请求header中需要设置Content-Type=application/json;charset=utf-8)、UTF-8编码。
- 正式环境接口地址访问前缀:https://api.xinrenxinshi.com
请求Header:
key | value |
---|---|
access_token | 获取的access_token的实际值 |
Query参数:
key | value |
---|---|
sign | 签名值 |
请求body:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
timestamp | Integer | Y | 请求时间戳(精确到毫秒,5分钟内有效) |
公共响应参数:
参数 | 类型 | 必传(Y/N) | 说明 |
---|---|---|---|
errcode | Integer | Y | 0成功,其他失败 |
errmsg | String | Y | 操作结果描述 |
data | Object | N | 结果数据 |
三、签名
为防止请求数据被恶意篡改,每次请求业务接口时,需对请求参数进行签名计算, 薪人薪事开放平台会对请求中的sign签名进行验证,验证通过才会处理业务逻辑。
签名方式请参考签名规则
四、调用频率
接口调用的频率默认限制为每分钟200次, 特殊的频率限制请参考对应接口的详细说明文档。