自動化と開発者

REST API

キャンペーン、応募、ユーザーをプログラムから読み取り・管理できます。

PeekHire REST API を使うと、自社のソフトウェアで採用データを扱えます。標準的な HTTPS + JSON API なので、Web リクエストを送信できる言語やツールであれば利用できます。

インタラクティブな OpenAPI リファレンスで、すべてのエンドポイント、パラメーター、スキーマを確認できます。

ベース URL とバージョニング

API にはバージョンがあります。すべてのエンドポイントは /api/v1 プレフィックス配下にあるため、今後の変更で連携が壊れることはありません。

すべてのリクエストは、ベアラートークンとして送信する API キーで認証します。

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

API キーをクライアントサイドのコードや公開リポジトリに埋め込まないでください。

v1 API は、採用に関する主要なオブジェクトをカバーしています。

レスポンスは JSON で、キャンペーンのタイトルやステータス、応募のステージや言語など、アプリで表示されるフィールドが含まれます。

一覧エンドポイントは結果をページ単位で返します。ページネーションパラメーターを使って大量の結果を順に取得し、対応している場合はフィルターを使って必要なものだけを取得できます。

API は標準の HTTP ステータスコードを使用します。成功は 2xx、リクエストの問題（キーの欠落や無効なキーなど）は 4xx、予期しないサーバーエラーは 5xx です。エラーレスポンスには、何が問題だったかを説明するメッセージが含まれます。