OpenAPI 提供以编程方式管理租户资源的 HTTP 接口：管理 API Key、查询用量等。

  • Base URL：https://www.51kik.com
  • 路径前缀：/openapi/*

认证

所有 OpenAPI 路由须携带访问令牌：

X-Access-Token: ot_your_access_token

令牌在控制台创建（前缀 ot_），代表当前租户身份；tenant_id 由服务端从令牌解析，无需在请求中传入。

详见 访问令牌。

响应格式

成功：

{
  "code": 0,
  "message": "success",
  "data": { }
}

错误响应

HTTP 状态码与响应体 code 相同；失败时 data 为 null。

HTTPcode场景
401401未携带 X-Access-Token，或令牌无效 / 已禁用 / 已过期
400400Query / Body 格式错误，或业务校验失败（如工号不存在、空 PATCH body、删除/获取明文时密钥不存在）
40040001用量查询未满足「trace_id / user_id / agent_name 三选一」
404404GET 详情或 PATCH 时目标资源不存在（如 API Key id 不存在）

未携带令牌：

{
  "code": 401,
  "message": "X-Access-Token header is required for OpenAPI endpoints.",
  "data": null
}

令牌无效、已禁用或已过期：

{
  "code": 401,
  "message": "The access token is invalid, disabled, or expired.",
  "data": null
}

用量查询筛选不合法（HTTP 400）：

{
  "code": 40001,
  "message": "必须且只能提供 trace_id、user_id、agent_name 中的一个",
  "data": null
}

当前接口

能力文档
API Key 增删改查API Key 管理
按 trace / user / agent 查用量用量查询

相关