接口规范说明(必读)✨
请求鉴权 ⭐⭐⭐
接口使用 API 密钥进行授权。前往获取 API 密钥,请求接口时需在 Header 添加参数 Authorization,其值为在 Bearer 之后拼接 Token
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
如果未提供 API-KEY,或者提供的 API-KEY 密钥无效,则 API 将返回包含以下报文的401响应:
{
"code": "401",
"msg": "请登录或提供API-KEY"
}
数据返回格式
正确请求接口后返回的格式统一如下,其中code为响应代码,message为响应说明,data为实际响应数据
{
"code": 200,
"message": "success",
"data":"...."
}
全局响应状态码
当请求接口后但是接口端未能正常处理数据或未能返回结果,接口将依据以下标准返回错误代码code,您可参考下表列出的错误码进行排查或联系我们获取帮助
code状态码 | 描述 | 解决方案 |
---|---|---|
200 | 成功 | 接口成功响应 |
201 | 任务已提交 | 异步响应接口,请自行查询结果 |
401 | 未正确提供API-KEY | 正确提供API-KEY |
429 | 并发请求达上限 | 根据实际message报文处理 |
500 | 非预期错误 | 根据响应联系支持获取帮助 |
1001 | 用户账户余额不足 | 前往个人中心充值后重试 |
1002 | 用户权限不足(VIP独享接口) | 升级为会员后重试 |
5001 | 处理失败未能返回预期结果 | 稍后重试或查看返回的message消息 |
最后修改时间: 3 小时前