开发文档

平台接口全局规范、鉴权、返回码说明

平台概述

3AAPI提供各类实用HTTP接口,所有接口支持HTTPS加密访问,请求响应统一JSON格式。

  • 接口域名:使用HTTPS协议,禁止HTTP明文生产调用
  • 字符编码:统一 UTF‑8
  • 数据格式:全部返回 JSON

鉴权方式

全部接口采用请求头 Authorization 携带Token鉴权。

Authorization: 你的个人Token
安全提示:Token等同于账号权限,不要放在前端浏览器直接调用,避免泄露被盗刷额度;泄露请立刻前往个人中心重置密钥。

统一返回格式

{
  "code": 200,
  "msg": "success",
  "data": {},
  "request_id": "xxxx-xxxx-xxxx"
}
  • code:状态码,200代表业务成功
  • msg:提示信息
  • data:业务返回数据,失败时可能为空
  • request_id:请求唯一ID,排错提供给客服

全局状态码

code 说明
200 业务请求成功
401 Token无效、缺失或已重置
403 权限不足、调用额度耗尽、账号被限制
422 请求参数校验错误
429 QPS超限,请求频率过高
500 服务端内部异常
503 接口临时维护,稍后重试

调用约束与最佳实践

  • 生产环境必须使用HTTPS请求
  • 业务做好重试逻辑,5xx错误可以短暂间隔后重试,4xx不要重复重试
  • 高并发业务控制QPS,参考套餐文档上限,超限会返回429
  • 问题反馈带上 request_id,便于快速定位日志

相关链接

接入教程:多语言代码示例快速上手

API列表:各个接口详细入参出参

常见问题:排查调用报错

联系客服:技术咨询与商务对接