帮助中心
所有文章
使用指南
API 异常处理
最后更新于 2023/01/09   阅读数 257

如果对订阅蜂REST API发起的请求失败,则响应里将包含一个八位错误代码,并带有相应的错误消息,以描述错误的详细信息。

以下代码段是包含错误代码和消息对的示例错误响应:

"success": false
"code": 14300405,
"message": "员工名称为必输入,请输入员工名称!"
1
2
3
plaintext

success字段指示API请求是否成功。

code错误代码以1开头,表示您遇到了订阅蜂REST API资源特有的问题。例如,14300405表示为员工对象的名称字段为必输字段。

以9开头的错误代码通常表示发生了与身份验证相关的问题,根据不同的情况,它还可以表示其他意外错误。例如,90000011表示请求标头中提供了无效凭据。

对错误进行故障排除时,可以将错误代码分为两部分:REST API资源代码和错误类别代码。请参阅以下订阅蜂错误代码示例:

注意:订阅蜂根据请求确定资源代码。因此,如果不包含有效的GET和DELETE请求失败,您将获得100000作为资源代码,这表示未知对象和未知字段。这些请求的错误类别代码有效,并遵循错误类别代码部分中描述的规则。在这种情况下,您可以参考返回的错误消息进行故障排除。

REST API资源代码

6位资源代码表示发生问题的REST API资源,通常是订阅蜂对象的字段。在前面的示例中,143004引用员工对象的名称字段。

所有REST API资源代码的值范围为100000到599999。有关资源代码的完整列表,请参阅API 资源代码

REST API 错误代码

2位错误类别代码标识错误类型,例如,未找到资源或缺少必填字段。

下表描述了所有错误类别和相应的解决方案:

代码

错误分类

描述

解决方案

01

权限或访问被拒绝

无法处理该请求,因为缺少特定权限

检查响应消息中缺少的用户权限,并联系订阅蜂客户支持以获得帮助。

02

身份验证失败

由于API身份验证凭据无效,身份验证失败。

检查并确保指定了有效的API凭据

03

无效的格式或值

由于字段格式或值无效,无法处理请求。

检查错误消息中的无效字段,并确保传入的所有字段的格式和值都有效。

04

请求中的未知字段

无法处理请求,因为请求正文中存在未知字段。

检查响应消息中的未知字段名称,并确保在请求正文中不包含任何未知字段。

05

缺少必填字段

无法处理请求,因为请求正文中缺少必需字段。

检查响应消息中的未知字段名称,并确保在请求正文中不包含任何未知字段。

06

缺少必需的参数

无法处理该请求,因为缺少必需的查询参数。

检查响应消息中缺少的参数名称,并确保在查询中包含该参数。

07

未找到

找不到指定的资源。

检查响应消息并确保使用订阅蜂指定的资源。

08

不支持的请求

请求的终结点不支持指定的HTTP方法。

检查您的请求并确保端点和方法匹配。

09

格式错误的请求

由于JSON语法错误,无法处理该请求。

检查JSON请求正文中的语法错误,并确保请求采用正确的JSON格式。

本篇目录

REST API资源代码

REST API 错误代码