账户与账单
API 密钥
如何创建、重命名、设置过期时间和删除 API 密钥,以便从你自己的代码中调用 FlowHunt API。
API 密钥让脚本或应用程序无需登录即可代表你的工作区调用 FlowHunt API。密钥属于工作区,而不是你个人,因此使用密钥发起的调用会以该工作区的身份执行。
创建密钥#
打开 API Keys 选项卡
在账户区域点击 Settings,然后点击 API Keys 选项卡。
添加密钥
点击 Add API Key。在 Create API Key 对话框中,输入一个能说明该密钥用途的 Name,例如 “Nightly export script”。点击 Add API Key 确认。
立即复制
下一个对话框会显示该密钥,并带有一个 Copy to clipboard 按钮。FlowHunt 只显示完整密钥一次,之后无法再次显示。请将其存放在密钥管理器或环境变量中,绝不要放在你提交的代码里。
如果你丢失了密钥,请创建一个新的,并删除旧的。
使用密钥#
同一个对话框中还有 Try API key,它会打开 api.flowhunt.io/docs 上的 API 参考文档。该参考文档列出了每个端点,并说明如何发送密钥。PHP SDK 按钮则链接到面向 PHP 项目的 FlowHunt PHP 包。
管理你的密钥#
API Keys 列表显示每个密钥的 Name、密钥的掩码版本、Last used(上次使用时间)以及 Valid to(有效期至)日期。
- 重命名或设置过期时间。 打开一个密钥,修改其 Name 或 Valid to 日期,然后点击 Update API Key。过期日期只能在创建后设置。
- 删除密钥。 打开密钥,点击 Remove API Key,然后确认。任何仍在使用该密钥的东西都将停止工作。
- 搜索。 使用列表上方的搜索框查找密钥。
利用 Last used 找出已无人需要的密钥。从未使用过、或者数月未使用的密钥,是删除的好候选。
谁可以执行这些操作#
Owner 和 Admin 可以创建、编辑和删除密钥。Editor 可以查看列表并创建密钥,但不能编辑或删除密钥。Member、Guest 和 Maintainer 看不到该选项卡。参见团队与角色。
你的套餐不会限制你创建多少个密钥。已取消的工作区无法创建密钥。
像对待密码一样对待密钥
任何持有该密钥的人都可以以你的工作区身份调用 API。如果某个密钥可能已泄露,请将其从列表中删除并创建一个替代密钥。