Authentication API
These are APIs for connection authentication.
| API | Overview |
|---|---|
| OAuth | Authenticate the app. |
| Token | Acquire an Access Token. |
Resource API
These are APIs for acquiring the master information and the data registered with HRBC.
It is necessary for users to access the Company DB in order to handle the master information and data. Perform the procedure for granting access to the Company DB when starting development.
The following shows the APIs for acquiring the master information.
| API | Overview | Processing | Necessary Scope |
|---|---|---|---|
| Partition | Acquires the partition information. | Read | partition_r |
| User | Acquire the user information. | Read | user_r |
| Field | Acquire the item information of the resource. | Read | field_r |
| Option | Acquire option information by specifying search conditions. | Read | option_r |
The following shows the APIs for data acquisition and registration.
| API | Overview | Processing | Necessary Scope |
|---|---|---|---|
| Client | Acquire company information by specifying search conditions. | Read | client_r,user_r,option_r |
| Register or update company information with the specified details. | Write | client_w | |
| Recruiter | Acquire information on a company recruiter by specifying search conditions. | Read | recruiter_r,client_r,user_r,option_r |
| Register or update information on the company recruiter with the specified details. | Write | recruiter_w | |
| Contact | Acquire contact information by specifying search conditions. | Read | contact_r,client_r,user_r,option_r |
| Register or update contact information with the specified details. | Write | contact_w | |
| Job | Acquire job openings information by specifying search conditions. | Read | job_r,recruiter_r,client_r,user_r,option_r |
| Register or update job openings information with the specified details. | Write | job_w | |
| Candidate | Acquire personal contact information by specifying search conditions. | Read | candidate_r,user_r,option_r |
| Register or update personal contact information with the specified details. | Write | candidate_w | |
| Resume | Acquire resume seekers information by specifying search conditions. | Read | resume_r,candidate_r,user_r,option_r |
| Register or update resume seekers information with the specified details. | Write | resume_w | |
| Process | Acquire process information by specifying search conditions. | Read | process_r,candidate_r,resume_r,client_r,recruiter_r,job_r,user_r,option_r |
| Register or update process information with the specified details. | Write | process_w | |
| Activity | Acquire activity information by specifying search conditions. | Read | activity_r,client_r,recruiter_r,job_r,candidate_r,resume_r,process_r,sales_r,user_r,option_r |
| Register or update activity information with the specified details. | Write | activity_w | |
| Contract | Acquire contract information by specifying search conditions. | Read | contract_r,client_r,user_r,option_r |
| Register or update contract information with the specified details. | Write | contract_w | |
| Sales | Acquire sales information by specifying search conditions. | Read | sales_r,client_r,candidate_r,resume_r,job_r,recruiter_r,user_r,option_r |
| Register or update sales information with the specified details. | Write | sales_w | |
| Opportunity | Acquire opportunity information by specifying search conditions. | Read | opportunity_r,recruiter_r,client_r,user_r,option_r |
| Register or update opportunity information with the specified details. | Write | opportunity_w | |
| Phase | Acquire phase information by specifying search conditions. | Read | phase_r |
| Register or update phase information with the specified details. | Write | phase_w | |
| Attachment | Acquire attachment information by specifying search conditions. | Read | attachment_r,process_r,resume_r,candidate_r,job_r,recruiter_r,client_r |
| Register or update attachment information with the specified details. | Write | attachment_w |