跳到正文
LumiPath API

鉴权

Bearer API Key、只能访问自己的账号,以及 401 的含义。

API Key

每个请求都要把 Key 作为 Bearer token 发送:

Authorization: Bearer lumi_xxxxxxxx
  • 在 设置 → API Keys 创建,一律以 lumi_ 开头。 Authorization 头里不是这个格式的值会被忽略。
  • 每个账号只有一把 Key。在控制台重新生成后,旧 Key 立即失效。
  • X-Api-Key 请求头是内部机制,不接受用户 Key。请始终使用 Authorization: Bearer。

缺少 Key 或 Key 无效时返回:

HTTP/1.1 401 Unauthorized

{ "error": "Unauthorized" }

Key 能访问什么

每个请求都以 Key 所属用户的身份执行,只能查看和操作该用户名下的账号连接。

  • 请求一个不存在的 id,或属于别人的 id,都返回 404 NOT_FOUND。API 不会透露别人的资源是否存在。
  • 没有角色或权限范围:一把 Key 可以调用该用户的所有接口。见安全须知。

账号连接的平台授权

账号连接可能还在,但在平台侧已经不能用了。这种情况返回 401 和具体错误码,问题出在社交账号,不是你的 API Key:

错误码含义处理方式
ACCOUNT_UNLINKED这个连接没有保存平台授权。请用户在控制台重新连接该账号。
TOKEN_EXPIRED平台拒绝了保存的授权(过期或被撤销)。请用户在控制台重新授权该账号。

请根据 error 错误码分支处理,不要只看 HTTP 状态码,见返回与错误。

本页目录