まずAPIキーが必要です。ダッシュボードの Developer → API
Keys から作成してください。キーは
iv_live_ で始まります。以下の各リクエストの
x-api-key ヘッダーに設定し、<slug> をご自身のチームスラッグに置き換えてください。構築するもの
ステップ 1 — 面接担当者(Interviewer)を作成する
これが 面接担当者(Interviewer) です。人格(パーソナリティ)と評価対象を決定します。id をコピー してください。これを INTERVIEWER_ID と呼びます。
ステップ 2 — ロールを定義する
これが ロール(Role) です。職務の内容と合格基準を定めます。id をコピー してください。これを ROLE_ID と呼びます。
ステップ 3 — ラウンドを追加する
これが ラウンド(Round) です。ロールと面接担当者を紐づけます。ステップ 4 — 候補者を追加する
これが 参加者(participant) です。id をコピー してください。これを CANDIDATE_ID と呼びます。
ステップ 5 — 面接を送信する
これが セッション(session) です。招待メールは自動的に送信されます。join_url が含まれ、招待メールが送信されたことが確認できます。
ステップ 6 — 結果を取得する
Jane が面接を終えると、彼女のスコアカードを2つの方法で取得できます。おすすめ: Webhook
session.completed イベントを購読してください。面接が終わった瞬間に届きます。シンプル: ポーリング
status が completed になるまで GET /api/v1/sessions/{id} を確認します。これで完了です 🎉
フルの採用フローを構築できました。ラウンドをさらに追加するには、より大きいstage_order とより厳しい面接担当者を指定して ステップ 3 を繰り返してください。