文档开发者能力

完整使用说明

API 入门与参考

通过公开 API 自动化链接、域名、分析和工作区操作。

在线 API 参考

登录后打开“API 参考”，可查看按业务分组的端点、参数和鉴权要求。完整 OpenAPI JSON、Scalar 和 Swagger 页面也可从该页打开。

鉴权与工作区

浏览器会话：适合控制台和交互调试
API Key/Bearer：适合服务端集成
x-cubelink-tenant-id：显式指定当前工作区（仅可访问有权限的工作区）
按密钥 scopes 限制 links、analytics、domains 等能力

幂等请求

创建地址、购买域名、支付等有副作用的端点可能要求 Idempotency-Key。每次逻辑操作生成一个唯一值；网络重试时复用同一个值。

curl https://wjl.ink/api/v1/links/create \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'x-cubelink-tenant-id: WORKSPACE_ID' \
  -H 'Idempotency-Key: 8a7db15b-4d02-4a17-9a0a-8d5f711841f7' \
  -H 'Content-Type: application/json' \
  --data '{"domainId":"DOMAIN_ID","slug":"launch","url":"https://example.com"}'

错误处理

400：字段或幂等键无效
401：未认证或密钥失效
403：scope、角色或工作区权限不足
404：资源不存在或不属于可见范围
409：短码冲突或状态冲突
429：超过速率限制

上一篇成员与权限下一篇API 密钥