响应代码
我们使用标准HTTP代码表示成功执行或指示发生错误时。对于某些错误,响应将包括有关错误的其他信息,包括应用程序错误代码和人类可读错误描述。成功执行
执行成功执行的操作将返回2xx代码,并且在适当情况下,将返回直接在响应主体中请求的信息。下表显示了用于API支持的各种HTTP动词的典型响应代码,实体和标题:
操作动词 | HTTP响应代码 | 注意事项 | 响应体 | 响应标题 |
---|---|---|---|---|
get | 200. | 请求的数据(订单,文档等)为JSON或XML | ||
帖子 | 201. | 当帖子将导致新实体时使用,例如下订单 | 空的 | 位置 - 将包含新实体的URL |
帖子 | 204. | 当POST简单地执行操作时使用,没有创建新实体,例如,取消订单 | 空的 |
误差处理
由于客户端(例如无效输入)上的问题导致错误的操作将标定4xx代码。导致由于REV服务器中的问题导致错误的操作将返回5xx代码。
如果标准的HTTP错误具有足够的描述性,例如,401(未授权)或404(未找到),响应机构将为空。对于其他情况,我们将使用客户端错误(400)的通用响应代码,并且响应将包括错误实体,其提供有关错误的进一步详细信息,包括应用程序错误代码和人类可读错误描述。此错误实体的格式如下:
{/ *数字错误代码。每个操作指定可能的错误代码及其含义。* /“代码”:“10001”,/ *人类可读错误消息* /“消息”:“无效的音频长度”}
<! - 数字错误代码。每个操作指定可能的错误代码及其含义。- > 10001 code> <! - 人类可读错误消息 - >
无效的音频长度 message> 错误>
下表显示了用于某些常见错误条件的HTTP响应代码和实体:
错误条件 | HTTP响应代码 | 响应体 |
---|---|---|
提交的数据以某种方式无效 | 400 | 错误实体,在JSON或XML中,具有适当的特定应用程序错误代码和消息,并可能详细信息。每个API操作都将记录可能的应用程序错误代码 |
未指定用户/客户端API密钥,或无效 | 401. | 空的 |
请求的操作无效(例如由于工作流规则或当前用户角色的限制) | 403. | 空的 |
请求的项目(例如订单,文件)不存在 | 404. | 空的 |
太多的请求/速率限制 | 429. | Rev允许您提出请求的速度。看看重试 标题为待额外请求等待到多长时间。我们不建议轮询订单状态。相反,使用我们的通知获得订单状态回调的机制 |
REV代码中存在意外错误 | 500 | 空的 |
Rev API已关闭维护 | 503 | 一些可以忽略的HTML |