API 密钥

API 密钥用于验证对 PeekHire 的程序化访问 — 包括 REST API 和你的无代码自动化。

创建密钥

1. 前往 开发者工具 → API 密钥 → 创建。
2. 为密钥设置一个描述性的名称（例如 Zapier integration），方便你记住 它的用途。
3. 在密钥值显示时立即复制 — 出于安全考虑，之后你将无法再次查看它。

使用密钥

在每个请求中将密钥作为 bearer token 发送：

curl https://your-api-host/api/v1/applications \
  -H "Authorization: Bearer YOUR_API_KEY"

权限

每个密钥都带有权限，用于限制它能执行的操作：

• 读取 — 获取数据（列出和检索营销活动、申请、用户）。
• 写入 — 创建或修改数据。

只授予集成所需的权限（最小权限原则）。只读密钥足以 将数据同步到电子表格或仪表板；只有当集成 需要在 PeekHire 中更改内容时，才添加 写入 权限。

保护密钥安全

• 像对待密码一样对待密钥。 任何拥有密钥的人都可以操作你的数据。
• 切勿将密钥提交 到代码仓库，也不要放在客户端代码中。
• 为每个集成使用单独的密钥，这样你可以撤销其中一个而不影响 其他集成。
• 将密钥存储在密钥管理器 或你的工具的凭证存储中，不要以 纯文本形式保存。

轮换和撤销

如果密钥已暴露 — 或者你只是按计划轮换密钥 — 请创建一个新密钥， 更新你的集成，然后删除旧密钥。删除密钥会立即撤销其 访问权限。