返回结果¶
保全网API的返回结果是一个Json字符串,正常返回时的Http status code为2xx,其它code均表示异常。
正常返回¶
正常返回的结果有两种情况,一般情况下是返回一个json,如下表所示:
字段名 | 描述 |
---|---|
request_id | 客户请求id |
data | 有效数据,具体在接口里面描述 |
例如:
{
"request_id": "2XiTgZ2oVrBgGqKQ1ruCKh",
"data": {
"attestation_id": "nXiTrBgQ1ruCKhgZ2oV"
}
}
另外一种是返回一个文件,比如下载保全文件时。
异常返回¶
异常返回的结果如下表所示:
字段名 | 描述 |
---|---|
request_id | 客户请求id |
message | 错误原因 |
timestamp | 时间戳,精确到毫秒 |
异常的Http Status Code
Code | 描述 |
---|---|
400 | 请求错误,比如参数不符合格式 |
404 | 请求路径不存在 |
405 | 请求方法错误 |
413 | 请求数据过大,比如上传文件过大 |
429 | 请求次数太多 |
500 | 请求失败,比如数字签名未通过 |
例如:
{
"request_id": "2XiTgZ2oVrBgGqKQ1ruCKh",
"message": "数字签名校验失败",
"timestamp": 1464672264000
}