文档与在线调试 · API 开放平台

接口文档

选择接口查看参数说明，填写 API Key 后可直接在线调试。

加载中…

GET ·

请求参数

参数	类型	必填	说明

响应示例

调用示例

在线调试

API Key（控制台获取）

响应结果

尚未发送请求

接入说明

所有接口统一鉴权：请求头 X-API-Key（也可用 Query 参数 key）。成功返回 code=0，业务数据在 data，计费与配额信息在 meta。

HTTP 状态码 / 业务码

状态码	含义	处理建议
200 / code=0	成功	解析 data 字段
400 / code=400	参数错误	检查请求参数
401 / code=401	未鉴权或 Key 无效	检查 X-API-Key
402 / code=402	积分不足	控制台充值
403 / code=403	接口下架 / 账号禁用	联系管理员
404 / code=404	接口或资源不存在	核对路径/短码
429 / code=429	触发限流或配额用尽	降低频率或次日重置后再试
500 / code=500	服务内部错误	稍后重试并反馈

响应结构

{
  "code": 0,
  "message": "ok",
  "data": { "...接口业务字段..." },
  "meta": {
    "api": "uuid.generate",
    "cost": 1,
    "latency": 12,
    "credits": 99,
    "quota": { "userUsed": 3, "userApiUsed": 3 }
  }
}