接口地址
所有接口的基本路径为 https://back-office-api.bitanswer.cn/bitanswer/api
其他接口在此基础上添加路径,如 https://back-office-api.bitanswer.cn/bitanswer/api/foo
。
公共请求头
所有API请求的请求头必须添加bitkey参数,参数值请见“控制台->费用->比特密钥”,没有密钥则无法使用API,需要向比特安索管理员提交使用申请。
请求示例
- GET
GET https://back-office-api.bitanswer.cn/bitanswer/api/foo
bitkey: xxx
这个用例表示向 https://back-office-api.bitanswer.cn/bitanswer/api/foo
发送GET请求,请求头中添加bitkey: xxx
- POST
POST https://back-office-api.bitanswer.cn/bitanswer/api/foo
bitkey: xxx
Content-Type: application/json
{
"foo":"boo"
}
这个用例表示向 https://back-office-api.bitanswer.cn/bitanswer/api/foo
发送POST请求,请求头中添加bitkey: xxx和Content-Type: application/json,
表示请求体以JSON格式入参,内容是
{
"foo":"boo"
}
部分接口的请求体需要以数组的形式入参,请求体示例如下:
[
{
"foo1": "boo"
},
{
"foo2": "boo"
}
]
注:本文所有接口的请求体都使用JSON格式,PATCH和DELETE请求需要输入请求体的与此示例同理。
响应示例
{
"status": 0,
"msg": "",
"data": {
"total": 0,
"items": [
{}
]
}
}
- 接口请求一定会有响应结果,固定包含status节点,当status返回值不为0表示请求异常,会返回msg节点解释错误原因。
- data节点包含响应的数据,不固定包含。
避免重复提交解决方法
适用场景
当网络情况不好、请求处理时间很长等情况时,导致请求超时,此时会需要重试。对于添加、修改、删除这些类型的请求重试可能会导致产生垃圾数据或重复更新,此时可以用请求ID来避免这种情况。
使用方法
- 在请求头中添加x-bit-req-id参数,值是唯一ID,开发商需要保证此ID一天内不会重复。
- 当收到含有请求ID的请求时,服务会判断请求ID是否重复,发现重复会返回5129错误。
- 发送方提交请求拦截到超时异常时,继续使用上一次的请求ID重试,如果收到5129错误意味着比特服务已经处理了请求,此时需要换一个请求ID发送新的请求。