管理 API 密钥
API 密钥是一个个人令牌,能让脚本或应用通过 KolleK 的 API 以你的身份进行操作。本页介绍它的整个生命周期:创建一个密钥、跟踪它,以及撤销它。至于用密钥具体能做什么,见 开发者章节。
如果你完全不打算使用 API,可以直接跳过这一页。在你创建之前,不会有任何密钥存在。
创建一个密钥
1
打开你的 API 密钥设置
进入个人资料,打开 API 密钥区域。你会看到已经拥有的密钥,以及每一个最后一次使用的日期。
2
给新密钥命名
选择创建一个密钥,给它起一个能说明用途的标签,比如“导入脚本”或“家庭仪表盘”。标签是给未来的你看的,方便判断哪个密钥可以放心撤销。
3
立即复制这个令牌
KolleK 只会在创建后显示这个令牌一次。请立刻复制它,保存到安全的地方,比如密码管理器。
::screenshot{label="新建的 API 密钥,令牌只显示这一次"}
警告
这个令牌只会显示一次。如果你弄丢了它,就无法再次查看,只能撤销这个密钥并新建一个。
每当你的用户名下有密钥被创建时,KolleK 都会给你发一封通知邮件,所以任何一个意外出现的密钥都不会被忽略。
跟踪你的密钥
API 密钥区域会列出每一个密钥、它的标签,以及最后一次使用的时间。这个最后使用时间很有用:一个几个月都没用过的密钥,大概率可以撤销;而一个五分钟前刚被使用、但你的脚本明明没有运行的密钥,则值得调查一下。
有一个习惯能让管理变得轻松:每个用途一个密钥。每个集成都有自己专属的密钥时,你就可以撤销其中一个,而不会影响到其他的。
撤销一个密钥
从同一个列表中删除这个密钥。任何还在使用这个令牌的东西会立刻停止工作,KolleK 也会给你发一封删除通知邮件。
以下情况适合撤销一个密钥:
- 你已经不再使用它所属的脚本或应用。
- 这个令牌可能已经泄露,比如被提交进了某个代码仓库,或者在聊天中被分享了出去。
- 你收到了一封你不认识的 密钥创建或删除提醒 邮件。在这种情况下,也请一并修改密码。
备注
通过 API 登录时,后台也会创建一个令牌。这类登录令牌不会触发密钥创建邮件,所以你收到的提醒始终具有实际意义。
接下来
- 用一个密钥完成你的第一次请求:使用 API 进行身份验证。
- 了解和密钥相关的各种邮件:登录与安全提醒邮件。
KolleK 文档
在 GitHub 上编辑此页
此页面有帮助吗?