跳到主要内容

iApp Core API — 以 JSON 获取您的用量报告与积分余额,构建自己的仪表盘

· 4 分钟阅读
Kobkrit Viriyayudhakorn
CEO @ iApp Technology

iApp Core API — 您的用量、您的积分、您的仪表盘

我们最常被问到的问题之一是:"能不能把用量数据从仪表盘导出到我们自己的系统里?" 现在可以了。全新的 Core API 以干净的只读 JSON 形式开放您 iApp 账户的用量报告与积分余额 — 用您已有的 API key,构建您的团队真正需要的仪表盘、告警或成本报表。

能获取什么

  • GET /credits — 实时剩余积分余额
  • GET /usage/summary — 任意时间范围的总请求数、消耗积分、成功率、延迟
  • GET /usage/timeseries — 按 小时/天/周/月 分桶,可直接绘图
  • GET /usage/services — 按服务拆分:请求数、积分、延迟、错误率
  • GET /usage/records — 原始调用日志,支持筛选(日期范围、服务、method、状态码、最低成本)、排序(时间、积分、延迟、状态)与分页,每页最多 1,000 行

整个集成只需一个请求头:

curl "https://iapp.co.th/api/core/v1/usage/summary?startDate=2026-08-01" \
-H "apikey: YOUR_API_KEY"

大家用它做什么

📉 余额不足告警 — 五行代码的 cron 任务,在积分耗尽前通知 Slack,而不是等到 HTTP 402 才发现。

📊 团队成本仪表盘 — 把 /usage/timeseries 拉进 Grafana 或 Google Sheets,一眼看出是哪天的批处理任务让 OCR 账单翻倍。

🧾 按客户分账 — 为多个项目运行 iApp API 的服务商,每个项目一个 key,再通过 /usage/records 中的 key 前缀拆分成本。

🚨 错误监控/usage/records?statusClass=4xx&sortBy=timestamp 就是您的 API 级错误日志,可直接接入现有可观测性系统。

安全是设计出来的

这套 API 是为"多疑"的工程师设计的(这是夸奖):

  • 只读。 所有端点均为 GET。即使 key 泄露,也无法通过此 API 创建 key、消费积分或更改账户。
  • 无个人信息。 响应只含技术遥测数据 — 时间戳、端点路径、状态码、积分、延迟。绝不含姓名、邮箱、用户 ID、客户端 IP 或请求内容。路径会去除查询字符串,API key 只显示前 8 位 — 即使报表泄露,也不会泄露任何敏感信息。
  • 仅您自己的数据。 不存在能触达其他账户的参数。
  • 限流 每 key 每分钟 120 次 — 对任何正常仪表盘都绰绰有余。

而且免费:调用 Core API 不消耗积分。

附带 Postman Collection

不想手写请求?导入我们现成的 Postman collection — 全部 6 个端点、可随时启用的筛选示例,以及 51 条内置测试断言(包括自动校验响应中绝不出现 PII 或完整 API key):

导入 collection 和环境文件,把 API key 填入 apikey 变量,即可用 Collection Runner 一键跑完整套测试。

与其他服务一样,公开监控、公开透明

Core API 已加入我们的公共状态页 Core Services 分组 — 与 60 多个 AI API 相同的 5 分钟健康检查 — 并与平台其他服务一起显示在实时统计页上。

60 秒上手

  1. API Key Management 获取您的 API key
  2. curl https://iapp.co.th/api/core/v1/ping -H "apikey: YOUR_KEY"
  3. 阅读完整文档 — 全部参数、Python 与 Node.js 示例,以及 20 行起步仪表盘

阅读文档 →