开发者文档 · 开放接口

错误码与限制

开放接口的返回结构、常见错误码与处理办法,以及使用上的限制。

返回结构

成功时 code 为 0,结果在 data;失败时 code 为错误码,msg 为说明,data 为空。

{
  "code": 1024017031,
  "data": null,
  "msg": "这个 API 密钥没有「查看反馈」权限"
}

请以 code 判断成败,msg 用于展示给人看。

常见错误码

错误码含义处理办法
1024017030API 密钥无效、已过期或已吊销检查 X-Api-Key 请求头是否带上、是否以 yqpj_pat_ 开头;密钥过期或吊销后需在「我的 → API 密钥」重新新建
1024017031密钥缺少该接口要求的权限,msg 会写明缺哪一项新建一把勾选了对应权限的密钥,见 认证与密钥
1024017033找不到要操作的项目,或按名称匹配到多个项目msg 里会列出你可选的项目(名称、业务编号、编号),改用项目编号或更准确的名称重试

此外,参数校验失败、业务规则不允许(例如不是项目创建者却修改仅创建者可改的字段)等情况,会返回对应的错误码和说明,按 msg 提示处理即可。

限制

  • 只能操作你有权处理反馈的项目:你创建的项目,或你已接受邀请的开发者项目;
  • 查看反馈单接口每次返回该项目最近 50 张;
  • 通过名称查找项目失败时,候选列表最多列出 20 个;
  • 登记上线时,同一项目、同一环境、同一提交重复登记会返回已有记录,不会重复推送;
  • 接入值守会换发新的处理端令牌,旧令牌随即失效,令牌只返回这一次;
  • 每次调用(包括失败的)都会记录调用接口、来源 IP 和结果。