ATSパートナー向けスポンサー求人API連携ガイド
APIを連携して、キャンペーンの予測やオーガニック求人のパフォーマンスと予測などのプライベートエンドポイントにアクセスします。
Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。
連携の概要
このガイドは、ATSパートナー向けスポンサー求人APIガイドおよびATSパートナー向けスポンサー求人APIリファレンスと併せてお読みください。このガイドは、ATSパートナーがスポンサー求人APIと連携する際に役立ちますが、すべてのエンドポイントを説明するものではありません。
このガイドと公開APIドキュメントでは、employerとadvertiserはいずれもIndeedで求人をスポンサーするユーザーを指します。技術的な質問はmarketplacesupport@indeed.comに送信してください。
プロトタイプを設計する前に、ユーザー体験を計画してください。ATSには、採用企業アカウントを作成するフローと、広告キャンペーンを管理するフローの2つを構築します。
| フロー | 説明 |
|---|---|
| 採用企業アカウントを作成する | 各採用企業には、Indeedアカウントが1つと、ATSが採用企業に代わって操作することを認可するプライマリアカウント管理者が1人必要です。このセットアップは、採用企業ごとに1回実施します。採用企業は複数のATSユーザーを持つことができますが、スポンサーキャンペーン用のIndeedアカウントは1つだけです。セットアップが完了するまで、採用企業はキャンペーンを作成できません。
実装の詳細については、採用企業アカウントをセットアップするをご覧ください。 |
| 広告キャンペーンを管理する | マーケットプレイス、求人パフォーマンスレビュー、分析ページなど、プラットフォーム内で最も適した場所にIndeedの広告体験を表示します。 APIを使用して、認可されたATSユーザーがATS内でIndeedのスポンサー求人キャンペーンを作成・管理できるようにします。ユーザーは次の操作を実行できます。
APIの詳細については、ATSパートナー向けスポンサー求人APIガイドをご覧ください。 |
連携手順
ATSパートナーとしてスポンサー求人APIを使用するには、次の手順に従ってください。構築時はブランドおよびロゴのガイドラインに従い、質問はmarketplacesupport@indeed.comに送信してください。
1. IndeedとDeveloper Agreementを締結する
Sponsored Jobs Integration APIsおよびReferral Partnershipの条件を含むDeveloper AgreementをIndeedと締結し、Indeedのパートナーになるから連携リクエストを送信してください。
Indeedがアカウントを承認すると、アクセスが有効になり、連携に関するアンケートが送信されます。
2. Indeedアカウントを作成して連携を登録する
ATS会社のメールアドレスでIndeedアカウントを作成します。このアカウントは、OAuth認可とATS連携の登録にのみ使用してください。セットアップ後は、このアカウントでクライアントの採用企業アカウントをIndeed上で管理します。
一意のATS識別 子を依頼するには、marketplacesupport@indeed.comにメールを送信してください。この識別子は、採用企業アカウントのセットアップに必要です。
Indeedのパートナーになると、Indeedは連携用のアプリを作成します。Partner Consoleにサインインすると、アプリとOAuth認証情報（クライアントID、シークレット、3-legged OAuthの認可コード）を確認できます。これらの認証情報をアクセストークンと交換して、API呼び出しを認証します。
3. Indeedがユーザーを送信するリダイレクトURLを特定する
ユーザーが採用企業アカウントのセットアップを完了した後に、IndeedがユーザーをリダイレクトするATSのURLを選択します。
4. 採用企業アカウントをセットアップする
新しい採用企業ごとに次の手順を完了し、その採用企業がIndeedで求人をスポンサーできることを確認します。
Indeedでスポンサー設定を行う
必要なアクセス権を持つ管理者ユーザーに、Indeedでスポンサー設定を行うよう求めるダイアログを表示します。ユーザーには企業メールアドレスの入力を求めます。
ユーザーアカウントをセットアップする
ユーザーをIndeedアカウントセットアップエンドポイントに送信します。このエンドポイントは、アカウントの準備状況を確認し、必要なセットアップをユーザーに案内します。
エンドポイントは次のとおりです。
https://ats-management.indeed.com/accountsetup次のパラメータを指定して、HTTP GETリクエストを送信します。
| フィールド | 必須 | 説明 |
|---|---|---|
__email | ✓ | Indeedでスポンサーに使用する、URLエンコードされたメールアドレスです。 |
ak | ✓ | Indeedが各ATSパートナーに割り当てる一意のIDです。パートナーがIndeedに紹介する採用企業アカウントを識別します。 |
state | IndeedがATSに変更せずに返す文字列です。リクエストのキーとして使用します。1〜100文字の英数字である必要があります。 | |
type | 次のいずれかを使用します。
|
このエンドポイントは、 管理者ユーザーをリダイレクトして、採用企業がスポンサーに対応できる状態かどうかを確認するために再利用できます。すべての確認に合格した場合、呼び出しはすぐに返り、追加のユーザー操作は発生しません。
このエンドポイントは、次の点を確認します。
- 企業メールアドレスのIndeedアカウントがIndeedを利用できる状態になっている。
- ユーザーがIndeedにサインインしている。
- 採用企業アカウントがスポンサーに対応するようセットアップされている。
- 請求情報がスポンサー用に設定されている。
- ユーザーが採用企業アカウントへのフルアクセス権を持っている。
いずれかの確認に失敗した場合、Indeedはユーザーを適切なセットアップページにリダイレクトし、セットアップ完了後に再度確認を実行します。
セカンダリユーザーの場合、アクセスできる採用企業アカウントのうち少なくとも1つが確認に合格する必要があります。
ユーザーをリダイレクトする
セットアップが完了すると、Indeedは指定されたリダイレクトURLでユーザーをATSにリダイレクトします。このリダイレクトURLはATS内に作成します。
エンドポイントが対応する必要があるパラメータ
| フィールド | 説明 |
|---|---|
state | 送信した値と同じ値をAPIが返します。 |
result | 値は次のいずれかです。
|
ユーザーにOAuth認可の付与を依頼する
成功した場合は、ユーザーを各採用企業からOAuth認可を取得するに送信します。
このフローは、Indeedでのスポンサー設定と請求情報の更新に使用します。
ユーザーの請求情報が有効でなくなった場合は、アカウント管理フローに送信して修正してください。
スポンサーなしのセットアップ
採用企業がIndeedアカウントを持っていないものの、求人をスポンサーする前にIndeedのパフォーマンスデータを確認したい場合は、リクエストURLにtype=loginを追加します。これにより、採用企業のIndeedアカウントが作成され、残りの確認はスキップされます。
採用企業が求人をスポンサーする前にオーガニック求人のパフォーマンスと予測エンドポイントにアクセスするには、type=loginを使用します。採用企業がアカウントのセットアップを完了したら、ユーザーをOAuth認可エンドポイントにリダイレクトします。
5. 各採用企業からOAuth認可を取得する
この認可は、新しい採用企業アカウントごと、およびそのセカンダリユーザーごとに取得します。スポンサー求人APIは、標準のOAuth 2.0 authorization code grantを使用します。エンドユーザーがIndeedアカウントとキャンペーンデータへのアクセスをシステムに付与し、付与されたアクセストークンでAPIを呼び出します。
クライアントに代わってAPIを呼び出すためのIndeedアカウントのOAuthセットアップと認可の取得は、authorization code grant type（3-legged OAuth）に従ってください。
認可コードリクエストでは、呼び出すエンドポイントのスコープを選択します。OAuthスコープをご覧ください。
Sponsored Jobs Campaigns APIのスコープに加えて、採用企業を表すアクセストークンを取得してください。採用企業を表すアクセストークンを取得するをご覧ください。
アクセストークンとリフレッシュトークンは安全に保管してください。各トークンのペアは1つの採用企業アカウントに固有であり、API呼び出しに必要です。トークンを失った場合、クライアントは再度OAuthアクセスを付与する必要があります。
セカンダリユーザーとOAuth認可
プライマリユーザーとは、採用企業アカウントをセットアップする管理者です。このユーザーは、その採用企業アカウントのすべてのリソースにフルアクセスできます。プライマリユーザーは、セカンダリユーザーと呼ばれる他のユーザーにアカウントへのアクセスを付与できます。プライマリユーザーは、IndeedのAccountページでセカンダリユーザーとその権限を追加・確認します。
Indeedでは、キャンペーンを管理する各ユーザーを セカンダリユーザーとして追加し、それぞれについてOAuth認可を取得することを推奨しています。各採用企業からOAuth認可を取得するをご覧ください。
ユーザーがアクセスできる採用企業アカウントの一覧を取得するには、ユーザー情報を取得するを使用します。
セカンダリユーザーに対するIndeedアカウントセットアップエンドポイントの動作は次のとおりです。
- ユーザーが、有効な請求情報を持つ採用企業アカウントの少なくとも1つにフル管理者アクセス権を持つ場合、エンドポイントは
OKの結果でユーザーをATSに戻します。 - それ以外の場合、エンドポイントは適切な採用企業アカウントがないことを示すエラーページを表示します。そのページには、
BILLING_SETUP_CANCELEDエラーでATSに戻るリンクがあります。
ユーザーがv2/api/userinfoエンドポイントから採用企業アカウントの1つを選択したら、アカウント管理エンドポイントを使用して、そのアカウントに有効な請求情報があることを確認してください。
6. 連携をテストする
連携をテストするには、クライアントアカウントとして使用する別のIndeedアカウントを作成し ます。メインのIndeedアカウントとは異なるメールアドレスを使用してください。
- このアカウントで
$50の予算を使用してUXをテストします。 - Indeedは、連携を確認できるよう、貴社の実際の求人に対するスポンサー求人クリックを最大
$200まで負担します。この返金は、このアカウントに対する1回限りの提供です。 - 成功をIndeedが確認できるよう、テストに使用するメールアドレスをIndeedからのメールに返信してください。
7. Indeedにデモ動画をメールで送信する
連携のデモをmarketplacesupport@indeed.comにメールで送信してください。
Subject: New ATS-SJI API Approval Request
Body:
ATS Name:
Product Contact:
BD/Marketing Contact:
Redirect URL (from Step 3):
UX Video:Indeedは48時間以内に返信し、連携を承認するか変更を依頼します。
8. メッセージングについてIndeedと連携する
クライアントが利用を開始できるよう、メッセージングについてIndeedと連携し、新機能を案内できるよう準備してください。未解決の質問はmarketplacesupport@indeed.comに送信してください。