Emplys API
Emply has an API in which data from the platform can be accessed. It is used, among other things, to retrieve data for other systems. To use Emply's API, you need to create an API key on your Emply platform. This is done by going to Settings > Integrations > API > click on 'New API key'.
Enter a title and click Save to continue.
Then you will get the overview of the generated API key, as well as the Client secret key. Additionally, one or more roles that have access to this API key must be selected and activated before the API key can be used in Emply's API. Finish by clicking Save.
Once the API key is created, it is found under API and you are now ready to make use of Emply's API: https://api.emply.com/.
There are many ways to retrieve and send data with the API through different endpoints. An endpoint is a location where you can read/send data related to a specific area. An example is our Candidate endpoint, in which all functionalities to access data related to candidates are located.
On the Candidate endpoint there are three options;
- Retrieve candidates created after a specific date
- Retrieve candidate by name
- Delete candidate
When you need to read/send data to an API endpoint you work with request-response methods. This means that you send a request to the API and then receive a response back. When making a query you have to fill in parameters that allow the API to look up the database for the right data. An example of parameters to be filled in on the Candidate endpoint;
The above endpoint sorts candidates by date and only looks up in the database candidates that have been created in the system after a specific date. Therefore this field must be filled in. The same applies to the client platform url. The API is generic and covers all platforms created in Emply, but to retrieve the right data, the API must look up the right customer database.* Once the two fields are filled in, it is possible to send the query (request) to the API. The API will then return a response;
A response from the API will always have a code. Based on the code, it is possible to assess whether the request was successful or whether something went wrong. If you receive a code 200, as in the picture above, then the request has passed and data is delivered. If, on the other hand, you receive a different code such as 400 or 404, then an error has occurred - for example, there may be no data on the candidate in the database.
*There cannot be connected to client platforms other than those from which the user has the right to retrieve data. To access data from Emply, an API key must be created in the platform. It is structured this way to ensure that data is only accessed by admins/IT users from that platform.
What data can be retrieved from Emply's API?
We have a number of endpoints where you can retrieve various data from the platform. Our endpoints relate to the different modules of the platform, such as in our example above with candidates retrieving data from the recruitment module. We also have employee endpoints that retrieve data from the HR module and exports that retrieve export files set up in the export menu.
Endpoints and explanation;
When you need to communicate with an API you use different methods depending on what you want to achieve with the data. The most common methods used are;
- GET: Get data
- POST: Create data
- PUT: Update or replace data (This method cannot be used with Emply's API)
- PATCH: Update or modify data
- DELETE: Delete data
In Emply's API we work primarily with GET, POST and DELETE methods. The methods vary at each endpoint, with some allowing both fetching, updating and deleting data. At others, there may be fewer options depending on the data.
To delve further into the details of our API, it is possible to view our documentation on our endpoints here. There is also the option to read further in our API articles, where we go through how you can work with our API to solve a specific task: