文档
// 文档

API 密钥

创建 API 密钥、了解权限范围，并妥善保管。

公开 API 使用 Bearer 密钥认证。密钥以 shl_live_ 开头，只在创建时完整显示一次。Shoulu 只保存哈希值，密钥丢失后无法找回，只能新建。

创建密钥

  1. 登录后打开「设置 → API 密钥」。
  2. 点击「创建 API 密钥」，填写名称并确认。
  3. 立即复制密钥。完整值不会再次显示。

权限范围

每个密钥同时带有两个 scope：

Scope允许的接口
urls:writePOST /api/v1/urls
tasks:readGET /api/v1/tasks/{id}

缺少所需 scope 的请求会返回 403 scope denied。

发送密钥

在 Authorization 请求头中携带密钥：

curl https://shoulu.co/api/v1/tasks/<task-id> \
	-H "Authorization: Bearer shl_live_<key>"

把密钥放在密钥管理器或环境变量中。不要把密钥提交进代码仓库，也不要在浏览器端调用。

吊销密钥

打开「设置 → API 密钥」，在对应行点击「吊销」。吊销在下一个请求时生效。