开始使用
Orbit 账户的组织方式、控制台各处的功能,以及从登录到让我们的网络开始应答一个域名的最短路径。
使用 API
控制台能做的一切。
一套 REST API、一个令牌,以及一份由服务器实际使用的路由表生成的 OpenAPI 文档 —— 因此它不可能描述一个不存在的端点。
01
获取令牌
- 为账户开启 API 访问。这需要账户上已有二次验证或通行密钥,在此之前默认关闭。
- 在 API 页面创建令牌。除非使用方确实需要写,否则选 read-only。
- 复制它。只显示这一次。
curl -H "Authorization: Bearer orb_…" https://dash.yunzheng.space/api/v1/me| 值 | |
|---|---|
| 基址 | https://dash.yunzheng.space/api/v1 |
| OpenAPI | GET /api/v1/openapi.json —— 无需鉴权 |
| 限流 | 每个令牌每分钟 300 次 |
| 每账户令牌数 | 10 |
02
当它拒绝时
{ "error": { "code": "validation_error", "message": "TTL must be between 60 and 86400." } }| 代码 | HTTP | 含义 |
|---|---|---|
unauthorized | 401 | 没有令牌,或令牌无效、已过期,或账户未开启 API。 |
forbidden | 403 | 只读令牌调用写路由,或团队角色不足。 |
not_found | 404 | 不存在 —— 或者不属于你,两者故意读起来一样。 |
limit_exceeded | 400 | 套餐配额限制。 |
conflict | 409 | 已存在,或名称被占用。 |
rate_limited | 429 | 一分钟内超过 300 次请求。 |
对于存在但属于他人的资源,同样返回
not_found。不要把 404 当作某个 id 未被占用的证据。03
列表与分页
多数列表使用偏移分页:limit(1 至 500,默认 100)与 offset。响应中带 pagination.next_offset,末页为 null。
Shield 请求日志改用 keyset 游标,因为对一个仍在写入的列表做偏移会导致跳行与重复。请传上一页的 next_cursor。
04
常见问题
令牌能做我能做的一切吗?
几乎可以。令牌管理、会话管理与账单结账只接受浏览器会话 —— 令牌不能铸造另一个令牌,也不能更改你的付费。
如何在变更时收到通知?
用 webhook。注册一个端点后,我们会对每次投递签名,使你能确认它来自我们,而不是来自某个知道了你 URL 的人。