如何调用API
说明
- 本文旨在说明企业应用程序如何调用每刻报销API。
各环境域名/出口IP
每刻在不同环境下所使用的域名不同,但是接口地址后缀均相同。
每刻阿里云服务器环境地址
每刻阿里云服务器固定出口IP(测试/正式通用)。每刻访问用户服务时, 用户服务器端有白名单限制的情况,可将以下IP加入白名单。
- 47.97.62.14
- 101.37.91.191
- 118.31.7.188
- 121.40.145.145
每刻钉钉云服务器环境地址(钉版)
接口调用流程
接口认证
用户向每刻申请openAPI账户 使用申请成功后获得的账户信息,通过访问接口认证获取token信息以及企业ID
接口协议
无特殊说明情况下,均使用HTTPS协议
请求头规范
Content-Type: application/json
tokenId: "通过[接口认证]获取的tokenId"
entCode: "通过[接口认证]获取的endCode"
设置Content-Type
将Content-Type指定为application/json
设置tokenId、entCode
在访问每刻时,需要提供每刻所需要的tokenId、entCode,并将其放置于请求头中。获取方式,具体可以参考文档接口认证
请求体规范
Json格式数据, 示例:
{
"departmentCode": "CODE001"
}
响应体规范
响应格式为Json,包含参数如下:
参数 | 类型 | 说明 |
---|---|---|
success | boolean | 是否响应成功 |
message | string | 异常信息 |
code | string | 异常code,ACK为成功,其他均为失败 |
data | json | 数据内容 |
示例:
{
"success": true,
"message": "成功",
"code": "ACK",
"data": {
"departmentCode": "DEPT0002",
"departmentName": "技术部"
}
}
HTTP 状态码说明
状态码 | 说明 |
---|---|
200 | 调用成功 |
401 | 登录过期 |
429 | 请求过多,调用频率过高 |
500 | 服务器异常 |