1. HIGH/V1接口通用说明
1.1.1. 调用限制
访问 微丰 开放接口(HIGH/V1),需要遵循以下规则:
- 所有API都是为服务器端调用设计,请不要在客户端(Web前端页面、手机应用等调用),否则可能会存在鉴权泄漏的风险。
调用地址
微丰开放接口的调用地址都符合以下格式之一:
https://rpa.wefeng360.com/[接口相对地址]?[URL参数]&appId=[appId]×tamp=[时间戳]&sign=[签名]
其中被中括号包含部分的含义如下:
变量 | 说明 |
---|---|
接口相对地址 | 您调用的具体API的相对URL,会在每个API中注明 |
URL参数 | 接口所需的Query String参数 |
时间戳 | 发起请求时的时间戳,格式为Unix Time,即从“1970-01-01 00:00:00”至今的秒数 |
appId | appId标识 |
签名 | 身份验证签名,除非明确说明,否则每次API调用都需要携带,计算方法参见下文 [鉴权方法] |
返回结果
- 微丰开放接口的返回数据同样为JSON格式格式编码的 UTF-8 字符串。
- 微丰开放接口在Response的header中会返回X-Request-Id标识一次唯一请求,如需微丰工程师协助定位接口调用疑问,请务必提供Response中的X-Request-Id。
1.1.2. 鉴权方法
规则说明
所有接口调用需要携带签名参数 sign,只有当 sign 值合法时请求才会被接受。 sign 的计算方法如下:
sign=SHA256(appId&secretKey×tamp)
其中:
- appId 为标识
- secretKey 为秘钥
- timestamp 为Unix time,即从“1970-01-01 00:00:00”至今的秒数。
- 注:timestamp有效期为10分钟
鉴权所需数据如下:
名称 | 数据 |
---|---|
appId | xxxxxxxxxxxxxxx |
secretKey | 5480583a6494445897pa3s1241 |
timestamp | 1619143576 |
计算sign:
sha256("xxxxxxxxxxxxxxx&5480583a6494445897pa3s1241&1619143576")
最终请求URL:
https://[调用域名]/[接口地址]?sign=fbdd2e45e3bd9d1f1e4915863cff62c2d6f901490070741b821ad55d7e231552×tamp=1619143576&appId=xxxxxxx