PeekHire ロゴ
自動化と開発者

APIキー

APIアクセスの認証に使うキーを作成し、スコープを設定し、ローテーションできます。

API キーは、PeekHire へのプログラムによるアクセスを認証します。REST API とノーコード自動化の両方で使用できます。

キーを作成する

  1. 開発者ツール → API キー → 作成 に移動します。
  2. キーの用途を後で思い出せるように、わかりやすい名前(例:Zapier integration)を付けます。
  3. キーの値が表示されたらコピーします。セキュリティ上、その後は再度表示できません。

キーを使用する

すべてのリクエストで、キーをベアラートークンとして送信します。

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

権限

各キーには、実行できる操作を制限する権限が設定されています。

  • 読み取り — データを取得します(キャンペーン、応募、ユーザーの一覧取得と詳細取得)。
  • 書き込み — データを作成または変更します。

連携に必要な権限だけを付与してください(最小権限)。スプレッドシートやダッシュボードへデータを同期するだけなら、読み取り専用キーで十分です。連携側が PeekHire 内の何かを変更する必要がある場合にのみ、書き込みを追加してください。

キーを安全に保つ

  • キーはパスワードのように扱ってください。 キーを持つ人は誰でもあなたのデータに対して操作できます。
  • キーをリポジトリにコミットしたり、クライアントサイドのコードに含めたりしないでください。
  • 連携ごとに別々のキーを使用してください。そうすれば、他に影響を与えずに 1 つだけ取り消せます。
  • キーはシークレットマネージャーまたは利用ツールの認証情報ストアに保存し、プレーンテキストでは保存しないでください。

ローテーションと取り消し

キーが漏えいした場合、または単に定期的にキーをローテーションする場合は、新しいキーを作成し、連携を更新してから古いキーを削除します。キーを削除すると、そのアクセス権はただちに取り消されます。