API Key:对外 API 接入指南

平台对外提供 Bearer Token 鉴权的 REST API,在「API Key」页自己创建。

创建 API Key

1. 「账户中心」→ API Key
2. 点「创建」,填一个用途备注(如 "我的 deploy 脚本")
3. 提交,Token 只显示一次,立即抄走保存。关掉就再也看不到
4. 列表里只能看到 Token 前 8 位(用作识别)

丢了就废掉重建,不能找回。

使用

所有对外 API 在 https://localhost.cc/api/v1/open/* 路径下。HTTP Header 加:

Authorization: Bearer <你的 Token>

示例:列出我的子域名

curl https://localhost.cc/api/v1/open/subdomains \
  -H "Authorization: Bearer YOUR_TOKEN"

示例:加一条 A 记录

curl -X POST https://localhost.cc/api/v1/open/subdomains/123/records \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"A","name":"@","value":"123.45.67.89","ttl":120}'

安全建议

• ✅ Token 写到环境变量或 secrets manager,不要硬编码到代码仓库
• ✅ 每个用途(CI / 本地 / 生产)用独立 Token,被泄漏时只废一个
• ✅ 定期检查「API Key」页面是否有不认识的 Key
• ❌ 不要在前端 JS 里暴露 Token,任何看 HTML 源码的人都能拿到
• ❌ 不要发到公开 GitHub 仓库(GitGuardian 等会扫描泄漏)

限流

• 单 API Key 每分钟 60 次请求(防误用)
• 资金 / 状态变动型操作(认领 / 释放 / 转让)单独限频
• 超频返 HTTP 429 Too Many Requests

撤销 / 删除

「API Key」列表点「删除」立即失效。已发出的请求若正在执行不会中断。

完整 API 列表

参见 API 接口文档(老文档,会持续更新)。