Do you want a solution where you can continuously retrieve updated data from Emply People and use it to update data in other systems? Emply People's API makes it possible to retrieve data on an employee, candidate or other when a change has occurred. It requires additional setup in the platform to make this solution work, but in return, the solution fits your needs. Use this article to set up the solution.
To build this solution, it is necessary to create an export template in the platform where all the data that is relevant to you is included. It is important to decide exactly what data you need to get out of Emply People and add it to the file. This is set up under ++.
Note
The setup is not Emply People specific, but follows common JSON rules.
In order for the solution to continuously generate exports that can be retrieved through the API, you need to build an automation. This ensures that when a selected action occurs in the system, a JSON package is generated from the template you have built. When building the automation, it is important to decide when the export should be generated, For example, when a candidate is hired, an employee updates a field in master data or something else.
To access the API, it is necessary to have an API key. This is set up inside the platform starting in the main menu and then clicking ++. Here you need to select a new API key and follow the instructions.
To retrieve the JSON files that are now automatically ready through the automation, it is necessary to use the right endpoints. They are located under our export collection in our API. To use these endpoints, you need to know the following data fields:
-
Customer = the customers platform url without .emply.com
-
ExportID = UID for the export. Can be found on the JSON export template
-
EntityID = UID for a generated export. Get it by calling the first endpoint.
Tip
Want to retrieve data on all employees for the first time? Use the following end point but you will need an employeeId which is retrieved from the get all employees endpoint.