跳到主要内容

第2步 API Key 的创建与维护

API Key 是客户端访问 HackStart API 的凭证。它的作用类似密码:谁拿到 Key,谁就能消耗你的额度。因此不要把 API Key 发到群里、截图公开、写进 GitHub 仓库或交给不可信软件。

创建 API Key

登录 HackStart 控制台,进入到 API Key 页面,点击创建或新增密钥;输入一个能看懂用途的名称;务必要选择分组;额度、速率或过期时间选项,按需要设置,如果是自用,就不需要设置额度、速率和过期时间;点击创建。

创建API key

当key创建好后,要确认你生成的key,是否有选择分组,是否在有效期内,状态是否活跃,这些都是非常重要的指标,不然会容易报错。

API密钥的状态

API密钥的维护

你可以因为不同的使用场景,而创建不同的key,同时你也可以给你身边的朋友创建单独的key,不过值得注意的是不要把同一个 Key 同时发给很多人。多人共用 Key 时,出了问题很难定位是谁产生了用量。

建议定期做这些维护:

操作什么时候做
重命名发现 Key 名称看不懂时
调整额度新人测试、活动任务或临时项目开始前
禁用 Key怀疑泄露、客户端异常、任务结束后
删除 Key确认不再使用时
轮换 Key长期使用、多人使用或权限变化时

如果 API Key 可能出现泄露,请立即在控制台禁用这个 Key,检查使用记录是否有异常请求,然后删除旧 Key,创建新 Key,并更新客户端配置。如果泄露发生在 Git 提交里,清理提交历史或联系仓库管理员处理。不要只改文档里的 Key。只要旧 Key 还处于启用状态,别人仍然可能继续使用。