自动化与开发者
REST API
以编程方式读取和管理活动、申请和用户。
PeekHire REST API 可让你自己的软件处理招聘数据。它是 标准的 HTTPS + JSON API，因此任何能发起网络请求的语言或工具 都可以使用它。
在交互式 OpenAPI 参考中探索每个端点、参数和 schema：
打开 API 参考文档基础 URL 和版本控制
API 采用版本控制。所有端点都位于 /api/v1 前缀下，因此未来的
变更不会破坏你的集成。
身份验证
每个请求都需要使用作为 bearer token 发送的 API 密钥 进行身份验证：
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
切勿将 API 密钥嵌入客户端代码或公开代码仓库中。
你可以访问的内容
v1 API 覆盖核心招聘对象：
- 招聘活动 — 列出并获取你正在招聘的职位。
- 申请 — 列出并获取候选人提交的申请。
- 用户 — 列出并获取你工作区中的成员。
响应为 JSON，并包含你在应用中看到的字段，例如 招聘活动的标题和状态，或申请的阶段和语言。
分页和筛选
列表端点会按页返回结果。使用分页参数浏览大型结果集， 并在支持的地方使用筛选器，只获取你需要的内容。
错误
API 使用标准 HTTP 状态码 — 2xx 表示成功，4xx 表示你的请求存在问题
（例如密钥缺失或无效），5xx 表示意外的
服务器错误。错误响应会包含一条消息，说明出了什么问题。