Skip to Content
API参考认证

认证

SupDesk API 位于:

https://api.supdesk.app/v1

每个请求都通过API密钥作为 Bearer token 进行身份验证:

curl https://api.supdesk.app/v1/submissions \ -H "Authorization: Bearer sd_live_..."

创建密钥

在控制台的工作区设置 → API密钥处创建密钥。每个密钥:

  • 限于单个项目 — 通过它读取和写入的一切都属于该项目;
  • 以可识别的前缀开头,例如 sd_live_,这样您可以在不暴露密钥的情况下在配置文件中识别密钥;
  • 仅显示一次创建时。SupDesk只存储密钥的哈希 — 如果您丢失了它,请撤销并创建新的。

密钥处理

请将API密钥视为密码。仅从您的服务器调用API — API故意没有CORS支持,这确保密钥无法从浏览器使用。如果密钥泄露,请在控制台撤销它;撤销立即生效。

认证失败

缺失、格式错误、已撤销或未知的密钥总是返回相同的响应,这样调用方就不能探测哪些密钥存在:

{ "error": { "code": "unauthorized", "message": "Invalid or missing API key." } }

读取 vs. 写入访问

所有计划都可以通过API读取写入端点(POST、PATCH、DELETE)需要工作区在付费计划 Pro 之上 — 在Free版,它们返回 403 forbidden 错误。参见限流与用量

Last updated on