Employer Registration APIガイド
候補者データを同期し、ATSとIndeedの間で機能設定を管理するために雇用主を登録します。
この API およびそのドキュメントを使用し、連携を構築することにより、お客様は追加 API 規約およびガイドラインに同意したものとみなされます。
Employer Registration APIを呼び出して、Candidate Sync連携用に雇用主を登録します。これにより、雇用主は機能設定を管理し、ATSとIndeedの間で候補者データを同期できます。
Employer Registration APIのワークフロー
Employer Registration APIと連携した後、次の操作を呼び出せます。
- 1.認証する。
- 2.雇用主を登録する:雇用主を登録し、登録情報を返します。
- 3.登録を更新する:登録を更新して機能を有効または無効にします。
- 4.登録を一覧する:雇用主の登録を一覧します。
- 5.雇用主の登録を解除する:登録を削除し、その機能を無効にします。
- 6.GraphQLエラーのトラブルシューティング。
Employer Registration APIリファレンス
registerEmployer:雇用主を登録し、登録情報を返します。manageFeaturesForEmployer:登録を更新して機能を有効または無効にします。findRegisteredEmployers:ATSの雇用主識別子で登録を一覧します。deregisterEmployer:登録を削除します。
認証する
Indeed パートナーになると、Indeed が連携用のアプリを作成します。Partner Console にサインインして、アプリと OAuth 認証情報(クライアント ID、クライアントシークレット、および 3-legged OAuth の場合は認可コード)を確認します。認証情報をアクセストークンと交換し、API 呼び出しを認証します。
Candidate Sync API の各オペレーションには OAuth トークンが必要です。
| API とオペレーション | OAuth トークン種別 |
|---|---|
| 雇用主を表す 3-legged OAuth トークン を使用し、 |
| 2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。 |
アクセストークンは ATS 内に安全に保存し、ユーザー間で共有しないでください。Indeed は、お客様のシステムが求人の信頼できる情報源であることを前提としています。あるユーザーが投稿した求人に別のユーザーのアクセストークンを使うと、Indeed 上でそのユーザーに別のユーザーの求人へのアクセスを付与する可能性があります。
アクセストークンを取得したら、クエリまたはミューテーションにこのトークンを含めます。最新の求人ステータスを確認するたびにユーザーへサインインを求めることがないよう、アクセストークンは有効期限が切れる前に更新することを推奨します。
Indeed と連携して API を呼び出す と スコープをご覧ください。
雇用主を登録する
リクエスト – Register employer
雇用主を登録し、登録情報を返すには、registerEmployer を呼び出します。
雇用主を表す 3-legged OAuth トークン を使用し、employer.ats_candidate.sync スコープで認証します。このトークンは雇用主の Indeed アカウントと ATS アカウントを関連付けます。Indeed の管理者またはオーナーが作成する必要があります。registerEmployer がスコープ不足のエラーを返す場合、このトークンが雇用主に関連付けられていない可能性があります。
RegisterEmployerInput では、次の入力フィールドを指定します。
| フィールド | 必須 | 説明 |
|---|---|---|
型: | ✅ | 雇用主を一意に識別するために指定する ID です。 1 つの |
型: | ✅ | 雇用主に対して指定する名称です。Indeed 上では、この名称が雇用主に表示されます。 |
レスポンス – Register employer
API は EmployerRegistration を返します。後続の Candidate Sync API 呼び出しで使用するために id を保存するか、partnerEmployerId を指定して findRegisteredEmployers でもう一度取得します。
登録を更新する
リクエスト – 登録を更新する
雇用主登録の機能を有効または無効にするには、manageFeaturesForEmployerを呼び出します。
2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
次の入力フィールドを指定します。
| フィールド | 必須 | 説明 |
|---|---|---|
型: | ✅ | ATSと雇用主の登録の一意のIDです。 この値は、 |
型: | ✅ | 更新する機能です。省略した機能と、現在のステータスのまま更新した機能は変更されません。重複は許可されません。 次の機能を
|
レスポンス – 登録を更新する
レスポンスはEmployerRegistrationを返します。
登録を一覧する
リクエスト – 登録を一覧する
雇用主の登録を一覧し、manageFeaturesForEmployerおよびderegisterEmployerで使用する登録IDを取得するには、FindRegisteredEmployersを呼び出します。
2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
次の入力フィールドを指定します。
| フィールド | 必須 | 説明 |
|---|---|---|
|
型: | ✅ | 雇用主を一意に識別するためにパートナーが指定するIDです。この値を使用して、雇用主の登録を一覧します。 |
型: | ⬜ | ATSと雇用主の登録IDです。この値を使用して、特定の登録を表示します。 この値は、 |
レスポンス – 登録を一覧する
フィルタに一致するEmployerRegistrationオブジェクトの配列を返します。
雇用主の登録を解除する
リクエスト – 雇用主の登録を解除する
登録を削除してその機能を無効にするには、deregisterEmployerを呼び出します。
2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
この登録を通じてIndeedに送信した雇用主データまたは候補者データも削除されます。
次の入力フィールドを指定します。
| フィールド | 必須 | 説明 |
|---|---|---|
|
型: | ✅ | ATSと雇用主の登録IDです。 この値は、 |
登録解除は永続的です。登録とその保存済み候補者データを復元することはできません。雇用主は再登録して、新しい登録IDを取得できます。
レスポンス – 雇用主の登録を解除する
DeregisterEmployerPartnerAtsSyncEmployerRegistrationPayloadオブジェクトを 返します。
エラーのトラブルシューティング
トラブルシューティングについては、次をご覧ください。
-
GraphQLにアクセスする前に発生する可能性があるOAuthエラーについては、OAuthエラーのトラブルシューティングをご覧ください。
-
GraphQLエラーについては、GraphQLエラーのトラブルシューティングをご覧ください。
-
求人掲載時の問題については、求人がIndeedに表示されないのはなぜですか?をご覧ください。