概览
身份验证与 API 密钥
每个请求都使用个人 API 密钥进行身份验证，密钥以 Bearer 令牌的形式发送。
发送密钥#
在每个请求中添加 Authorization 请求头：
GET /open/v1/me HTTP/1.1
Host: api.linework.app
Authorization: Bearer lwk_aBcD1234...所有请求都必须使用 HTTPS。不接受放在查询字符串或请求体中的密钥。
关于 API 密钥#
| 属性 | 详情 |
|---|---|
| 格式 | lwk_ + 40 个字母和数字 |
| 所有者 | 创建该密钥的 Linework 账号。所有操作都以该账号的身份执行。 |
| 权限 | 创建密钥时选择的权限范围。之后无法更改：请改为创建一个新密钥。 |
| 可见性 | 仅在创建时显示一次。Linework 只保存其哈希值，无法再次显示。 |
| 数量限制 | 每个账号最多 5 个有效密钥。 |
| 有效期 | 密钥不会过期。当您吊销密钥或开发者权限被撤销时，密钥即失效。 |
管理密钥#
所有操作都在 web.linework.app → 设置 → 开发者中完成：
- 创建密钥，为其命名并选择权限范围。
- 吊销密钥：密钥立即失效，且无法恢复。已吊销的密钥不计入 5 个密钥的限制。
- 查看每个密钥的上次使用时间，以找出不再需要的密钥。
轮换密钥#
- 创建一个具有相同权限范围的新密钥。
- 将其部署到您的集成中。
- 确认请求正常后，吊销旧密钥。
保护密钥安全#
- 将密钥保存在您的服务器上。切勿将密钥放入移动应用、浏览器页面、公开代码仓库或支持消息中。
- 只为每个密钥授予所需的权限范围，并为每个集成使用单独的密钥。
- 如果密钥泄露，请立即吊销并创建新密钥。Linework 工作人员绝不会向您索要密钥。
身份验证错误#
| 状态码 | 错误码 | 含义 |
|---|---|---|
| 401 | INVALID_API_KEY | 缺少请求头、密钥错误或密钥已被吊销。 |
| 403 | INSUFFICIENT_SCOPE | 密钥有效，但不具备此端点所需的权限范围。 |
| 403 | DEVELOPER_ACCESS_REVOKED | 该账号的开发者权限已被暂停或撤销，其所有密钥均已失效。 |
| 403 | PROFILE_INCOMPLETE | 写入类端点要求账号设置了头像和封面图。 |
所有错误码请参阅错误。