开发文档
每个接口一个地址:/api/v4/接口代号。请求头和返回值格式在这一页说清楚,每个接口自己的参数在各自那一页。
接口根地址
http://api.aiapizz.com/api/v4/
认证
每个密钥由 AppID 和 AppKey 组成。请求时放在请求头里:
X-App-Id: 你的 AppID
X-App-Key: 你的 AppKey
也可以放在地址参数里(appid / appkey),方便临时调试。AppKey 在创建时只显示一次,关掉页面就看不到了。
每个密钥都必须配置 IP 白名单,来源 IP 不在白名单里的请求一律拒绝。同一密钥每分钟能调多少次在后台设置,超了返回 429。
调用方式
接口支持 GET 和 POST(按各接口自己写的来)。接口代号就是地址的最后一段,参数放在 query、表单或 JSON 请求体里都行。
GET /api/v4/facehy?name=...&idcard=...
POST /api/v4/facehy 表单或 JSON 请求体
地址依赖伪静态规则(随程序带了 Apache 的 .htaccess 和 nginx 配置示例)。没开伪静态时用老写法 /api/v4/?act=facehy,功能一样。
返回格式
{
"code": 200,
"msg": "调用成功",
"data": { ... },
"trace": "20261017-A1B2C3D4E5",
"cost": "0.145",
"balance": "39.716"
}
code 为 200 表示成功,其余都是失败。失败时 data 是空的,msg 是能直接看懂的说明。trace 用来对账,出问题时把它提供给管理员。
cost 是这一次的扣费,balance 是扣完后的余额。没调成的那一次不扣费。
公共错误码
| code | 说明 |
|---|---|
| 400 | 参数缺失或格式不对 |
| 401 | AppID 或 AppKey 不正确 |
| 402 | 余额不足(含信用额度) |
| 403 | 来源 IP 不在白名单 |
| 404 | 接口不存在或未上架 |
| 405 | 请求方式不对 |
| 429 | 调用太频繁,稍后再试 |
| 500 | 服务端内部错误 |
| 502 | 上游服务暂不可用 |
| 503 | 接口尚未定价或暂不可用 |