- Employer Registration API workflow
- Employer Registration API references
- Authenticate
- Register employer
- リクエスト – Register employer
- レスポンス – Register employer
- Update registration
- Request – Update registration
- Response – Update registration
- List registrations
- Request – List registrations
- Response – List registrations
- Deregister employer
- Request – Deregister employer
- Response – Deregister employer
- Troubleshoot errors
Employer Registration API guide
Register employers to sync candidate data and manage feature settings between their ATS and Indeed.
この API およびそのドキュメントを使用し、連携を構築することにより、お客様は追加 API 規約およびガイドラインに同意したものとみなされます。
Call the Employer Registration API to register employers for Candidate Sync integration, which enables employers to manage feature settings and synchronize candidate data between their ATS and Indeed.
Employer Registration API workflow
After you integrate with the Employer Registration API, you can call these operations:
- 1.Authenticate.
- 2.Register employer: Register an employer, and return information about the registration.
- 3.Update registration: Update a registration to enable or disable features.
- 4.List registrations: List an employer's registrations.
- 5.Deregister employer: Delete a registration and disable its features.
- 6.Troubleshoot GraphQL errors.
Employer Registration API references
registerEmployer: Register an employer, and return information about the registration.manageFeaturesForEmployer: Update the registration to enable or disable features.findRegisteredEmployers: List registrations by ATS employer identifier.deregisterEmployer: Delete a registration.
Authenticate
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
リクエスト – 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 でもう一度取得します。
Update registration
Request – Update registration
To enable or disable features for an employer registration, call manageFeaturesForEmployer.
2-legged OAuth トークン. で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
Provide these input fields:
| Field | Required | Description |
|---|---|---|
Type: | ✅ | Unique ID for the ATS-employer registration. Set this value to the |
Type: | ✅ | Features to update. Omitted features and features updated to their current status remain unchanged. Duplicates are not allowed. Set these features to
|
Response – Update registration
The response returns EmployerRegistration.
List registrations
Request – List registrations
Call FindRegisteredEmployers to list an employer's registrations and get the registration ID for use in manageFeaturesForEmployer and deregisterEmployer.
2-legged OAuth トークン. で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
Provide these input fields:
| Field | Required | Description |
|---|---|---|
|
Type: | ✅ | Partner-provided ID that uniquely identifies the employer. Use this value to list the employer's registrations. |
Type: | ⬜ | ATS-employer registration ID. Use this value to show a specific registration. Set this value to the |
Response – List registrations
Returns an array of EmployerRegistration objects matching the filter.
Deregister employer
Request – Deregister employer
To delete a registration and disable its features, call deregisterEmployer.
2-legged OAuth トークン. で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。
Also deletes any employer or candidate data that you sent to Indeed through this registration.
Provide this input field:
| Field | Required | Description |
|---|---|---|
|
Type: | ✅ | ATS-employer registration ID. Set this value to the |
Deregistration is permanent. You cannot recover the registration or its stored candidate data. Employers can reregister to get a new registration ID.
Response – Deregister employer
Returns the DeregisterEmployerPartnerAtsSyncEmployerRegistrationPayload object.
Troubleshoot errors
To troubleshoot:
-
OAuth errors that can occur before you access GraphQL, see Troubleshoot OAuth errors.
-
GraphQL errors, see Troubleshoot GraphQL errors.
-
Issues that occur when posting jobs, see Why don't my jobs appear on Indeed?.