Creating job applications with public API

Creating job applications with Emplys public API can be very useful if you wish to handle the application process in your own systems or from your own website. This guide will show you how to set up your system so that the applications can be created and controlled externally.

Creating job applications with public API

Requirements

These requirements will include both the knowledge requirements that you will need internally in your organization, as well as the technical setup requirements in Emply needed.

Disclaimer: Please be aware that obtaining knowledge and technical requirements is the customers' own responsibility. Misuse of the public API can result in extra charges if Emply resources are required to fix the issue. 
Emply will not support the external setup of public API usage, scripts, data storage and execution time. This needs to be handled and agreed upon by internal resources in the organization.

Knowledge requirements:

• Scripting
• REST API
• JSON
• Data storage security and legality (if applicant data is stored outside of Emply)

Technical Emply requirements:

Clicking a point will open an explanation article in a new tab. Should questions or challenges arise during this setup, contact Emply support or your implementation agent and they will assist you with the setup.

• An application form with the privacy policy element present.
• A job template.
• A dummy job that can be used for testing.
• A dummy candidate on dummy job created in Emply with the correct application form.
• API key with the correct role sat up in Emply.

Data to be stored externally. 

To prevent excessive requests, it is advised that some data is stored and reused in the external service. This data includes:

• API key (Should be stored securely)
• Form ID of the application form
• VacancyId's (for jobs without an expiration time and talent pools)
• Response body template

For help getting the form ID, vacancy ID, and a response body template, follow this article and use this method to get the application data from your dummy job and candidate. Change/remove the dummy data from the response in step 3.

Testing creation of the application

After the setup steps have been completed, and form ID, vacancy ID, and response body template has been acquired, a test creation can be attempted through api.emply.com. Navigate to the POST /v1/{customer}/applications/create/{formId}/{vacancyId} endpoint, and complete these steps:

1. Authorize your API key in the top right-hand corner, by pressing the "authorize" button.
2. Fill in the formId field with the correct form ID
3. Fill in the vacancyId field with the correct vacancy ID
4. Fill in the customer field with the first part of your platform URL (example: test.emply.com would have the word "test" in this field)
5. Click the "Try it out" button.
6. Paste your response body template in the response body field.
7. Fill in the data of your template with the information you want to submit.
8. Click "Execute"

If this is done correctly, a code 200 response should be returned. A new candidate will be created in the corresponding job, and this candidate will appear in the "Sourced" step of the candidate list.

Important notes

Some things to keep in mind when creating applications externally:

• The privacy policy is automatically accepted when a candidate is created through the API, if the privacy policy element is added to the application form.
• Posting an application via the API while using an application form without the privacy policy element will not mark the privacy policy as accepted.
• The privacy policy status is not visible through the API, and will therefore not be included when you create your response body.
• The privacy policy should not be included in the POST body.
• The candidate profile will always appear in the "sourced" step of the candidate pipeline.
• Emply automation that uses the "candidate created" trigger will not be executed upon creation of candidates via the API.