This section describes the terms used for the HRBC API.
- User app
- Third-party app
- App name
- App ID
- Secret
- Redirect URL
- API access count
- Partition
- Resource
- Field
- Option
User app
User apps are apps that are developed by HRBC user companies in accordance with their purposes of use.
These apps include one that is used for linking HRBC and a user’s own site.
Third-party app
Third-party apps are those that are developed by third parties, not by PORTERS, HRBC user companies.
These apps include one that is used for linking entry information for external job openings media with HRBC.
App name
App names are used for identifying each app.
If not particularly specified, PORTERS assumes the name “company ID_api” and registers this name.
In the case of a third-party app, the app name is displayed on the app lists screen.
App ID
App IDs are IDs to identify individual apps.
These IDs are used for API authentication.
These IDs are issued when apps are registered with PORTERS, and cannot be optionally set or changed.
The example in this site takes App ID=ABC for the purpose of explanation.
Secret
Secret is an authentication pass that is issued for each app.
These passes are used for API authentication.
These passes are issued when apps are registered with PORTERS, and cannot be optionally set.
However, they can be re-issued (changed).
When changing the external development company, for example, it is recommended to change this item for ensuring security.
The example in this site takes Secret=XYZ for the purpose of explanation.
Redirect URL
An HRBC contract user is required to specify the Redirect URL when applying for the API.
The URL of the server where apps are to be executed should be registered as the Redirect URL.
The host part can be specified with IP, but the URL format must be used for registration.
This URL is used for API authentication.
The example in this site takes Redirect URL=http://myapplication.com for the purpose of explanation.
API access count
The API access count shows how many times the API was accessed (request) (including the requests for authentication), not the number of the page view times or jobs.
The API access count largely varies depending on how many times the API accesses are required to acquire information.
Example)
- Acquire information by accessing the API every time the user opens the page (Large access count)
- Acquire information by accessing the API every several hours periodically and accumulate the information in a user’s own DB (Small access count)
How to access the API differs depending on the program; however, PORTERS has no concern with the program details, so please contact the personnel in charge of the development.
Partition
HRBC manages the data of individual companies on an independent data unit basis.
This independent unit of company data is called Partition. It may also be called Company DB.
Resource
The data stored in a Partition is called Resource.
For example, data related to “Personal contact information” is called Candidate Resource, and data related “JOB” is called Job Resource.
The API that accesses these Resources is called Resource API.
Resources corresponds to the information of HRBC as follows:
| Resource Name | HRBC Default Menu Name (Optionally changeable) | ||
|---|---|---|---|
| HRBC Agent (For permanent employment) Japanese |
HRBC Stuffing (For temporary employment) Japanese |
English | |
| Client | 企業 | 企業 | Client |
| Recruiter | 企業担当者 | 企業担当者 | Recruiter |
| Job | JOB | 案件 | Job |
| Candidate | 個人連絡先 | スタッフ連絡先 | Person |
| Resume | レジュメ | スタッフ | Resume |
| Process | 選考プロセス | 引当/就業管理 | Process |
| Activity | アクティビティ | アクティビティ | Activity |
| Contract | 契約 | 契約 | Contract |
| Sales | 売上 | 個別契約 | Sales |
*Reference: Help for HRBC users: Data structure of HRBC
Field
The items defined in a Resource are called Fields.
When accessing each Resource, specify the Field for which you want to read or write data.
Option
Option is the master data that define options.
Option is associated as options with the option-type Field.
For an option-type Field, one or multiple items can be selected from the options of the associated Option.
