Employer Registration API guide

Register employers for Candidate Sync.

 

法的注意

この API およびそのドキュメントを使用し、連携を構築することにより、お客様は追加 API 規約およびガイドラインに同意したものとみなされます。

API overview

Call the Employer Registration API to register employers for Candidate Sync. Registration lets you sync candidate data between an employer's ATS and Indeed, and control which features each employer can use.

---

API steps

After you integrate the Employer Registration API, complete these steps to register and manage employers.

---

1. Authenticate

Indeed パートナーになると、Indeed が連携用のアプリを作成します。Partner Console （新しいウィンドウで開きます） にサインインして、アプリと OAuth 認証情報（クライアント ID、シークレット、および 3-legged OAuth の認可コード）を確認します。これらの認証情報をアクセストークンと交換し、API 呼び出しを認証します。

Candidate Sync API の各オペレーションには OAuth トークンが必要です。

Candidate Sync API オペレーションの OAuth トークンタイプ

API とオペレーション	OAuth トークンタイプ
Employer Registration API 採用企業を登録する	採用企業を表す 3-legged OAuth トークン を使用し、employer.ats_candidate.sync スコープで認証します。このトークンは採用企業の Indeed アカウントと ATS アカウントを関連付けます。Indeed の管理者またはオーナーが作成する必要があります。registerEmployer がスコープ不足のエラーを返す場合、このトークンが採用企業に関連付けられていない可能性があります。
Employer Registration API 登録情報を更新する 登録情報を一覧表示する 採用企業の登録を解除する Send Candidates API 応募を初期化し、添付ファイルをアップロードする 応募を送信する 応募ステータスを追跡する 応募を削除する Retrieve Candidates API 未確認のアセットを取得する 時間範囲でアセットを取得する テストアセットを作成する	2-legged OAuth トークン で認証します。ユーザー操作は必要ありません。

アクセストークンは ATS 内に安全に保存し、ユーザー間で共有しないでください。Indeed は、お客様のシステムが求人の信頼できる情報源であることを前提としています。あるユーザーのアクセストークンを別のユーザーが投稿した求人に使用すると、Indeed 上でそのユーザーに別のユーザーの求人へのアクセスを付与する可能性があります。

アクセストークンを取得したら、クエリまたはミューテーションにこのトークンを含めます。最新の求人ステータスを確認するたびにユーザーへサインインを求めることがないよう、Indeed ではアクセストークンの有効期限が切れる前に更新することを推奨しています。

Indeed と連携して API を呼び出す と スコープ をご覧ください。

---

2. Register employer

リクエスト – Register employer

採用企業を登録し、登録情報を返すには、registerEmployer を呼び出します。

採用企業を表す 3-legged OAuth トークン を使用し、employer.ats_candidate.sync スコープで認証します。このトークンは採用企業の Indeed アカウントと ATS アカウントを関連付けます。Indeed の管理者またはオーナーが作成する必要があります。registerEmployer がスコープ不足のエラーを返す場合、このトークンが採用企業に関連付けられていない可能性があります。

RegisterEmployerInput では、次の入力フィールドを指定します。

registerEmployer の入力フィールド

フィールド	必須	説明
partnerEmployerId 型：ID!	✅	採用企業を一意に識別するために指定する ID です。 1 つの partnerEmployerId を複数の Indeed アカウントに登録できますが、各 Indeed アカウントでは、ATS ごとに 1 つの partnerEmployerId のみを使用できます。同じ Indeed アカウントで別の partnerEmployerId を使用すると、Indeed は登録を新しい atsName と partnerEmployerId に更新します。
atsName 型：String!	✅	採用企業に対して指定する名称です。Indeed 上では、この名称が採用企業に表示されます。

レスポンス – Register employer

API は EmployerRegistration を返します。後続の Candidate Sync API 呼び出しで使用するために id を保存するか、partnerEmployerId を指定して findRegisteredEmployers でもう一度取得します。

---

3. Update registration

Request – Update registration

To enable or disable features for an employer registration, call manageFeaturesForEmployer.

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

Provide these input fields:

manageFeaturesForEmployer input fields

Field	Required	Description
indeedRegistrationId Type: ID!	✅	Unique ID for the ATS-employer registration. Set this value to the id that registerEmployer returns.
features Type: EmployerRegistrationFeaturesInput!	✅	Features to update. Features you omit, or set to their current status, remain unchanged. Duplicates are not allowed. Set these features to DISABLED or ENABLED: retrieveSourcedCandidatesClick: RetrieveSourcedCandidates.OneClick feature status. retrieveSourcedCandidatesAuto: RetrieveSourcedCandidates.AutomatedTransfers feature status. sendApplications: SendApplications feature status.

Response – Update registration

The response returns EmployerRegistration.

---

4. List registrations

Request – List registrations

Call FindRegisteredEmployers to list an employer's registrations and get the registration ID that manageFeaturesForEmployer and deregisterEmployer require.

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

Provide these input fields:

FindRegisteredEmployers input fields

Field	Required	Description
partnerEmployerId Type: ID!	✅	Partner-provided ID that uniquely identifies the employer. Use this value to list the employer's registrations.
indeedRegistrationId Type: ID	⬜	ATS-employer registration ID. Use this value to show a specific registration. Set this value to the id that registerEmployer returns.

Response – List registrations

Returns an array of EmployerRegistration objects matching the filter.

---

5. Deregister employer

Request – Deregister employer

To delete a registration and disable its features, call deregisterEmployer.

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

Deregistering also deletes the employer and candidate data you sent to Indeed through this registration.

Provide this input field:

deregisterEmployer input field

Field	Required	Description
indeedRegistrationId Type: ID!	✅	ATS-employer registration ID. Set this value to the id that registerEmployer returns.

Deregistration is permanent: you cannot recover the registration or its candidate data. Employers can reregister to get a new registration ID.

Response – Deregister employer

Returns the DeregisterEmployerPartnerAtsSyncEmployerRegistrationPayload object.

---

6. Troubleshoot errors

To troubleshoot:

• OAuth errors, which occur before you reach GraphQL, see Troubleshoot OAuth errors.
• GraphQL errors, see Troubleshoot GraphQL errors.
• Jobs that do not appear on Indeed, see Why don't my jobs appear on Indeed?.

---

GraphQL API references

• registerEmployer — Registers an employer. Authenticate with a 3-legged OAuth token that represents an employer and the employer.ats_candidate.sync scope.
• manageFeaturesForEmployer — Enables or disables features for an employer. Authenticate with a 2-legged OAuth token.
• findRegisteredEmployers — Lists employer registrations. Authenticate with a 2-legged OAuth token. Default page size is 50.
• deregisterEmployer — Deletes all features and removes a registration. Authenticate with a 2-legged OAuth token.

 

このページは役に立ちましたか？