Introductie tot Emply's API

Gewijzigd op Wed, 12 Jul 2023 om 02:12 PM

Emply's API

Emply heeft een API waarin gegevens van het platform kunnen worden opgehaald. Het wordt onder andere gebruikt om gegevens op te halen voor andere systemen.

Om de API van Emply te gebruiken, moet je een API-sleutel aanmaken op jouw Emply-platform. Dit doe je door naar 'Instellingen' > 'Integraties' > 'API' te gaan en op '+ Nieuwe API sleutel' te klikken.

Voer een titel in en klik op 'Opslaan' om door te gaan.

Hierna krijg je een overzicht van de gegenereerde API-sleutel, evenals de Client secret sleutel. Je zult één of meerdere rollen toegang moeten geven tot de API-sleutel en de slider op 'Geactiveerd' moeten zetten voordat je de API-sleutel gebruiken kunt. Klik op 'Opslaan' om het proces te voltooien.

Zodra de API-sleutel is aangemaakt ben je klaar om gebruik te maken van Emply's API.

De link naar de API indexpagina vind je hier: api.emply.com

Welke gegevens kunnen worden opgehaald uit de API van Emply

Er zijn verschillende manieren om gegevens op te halen en te verzenden met behulp van de API. Dit wordt gedaan via endpoints, een locatie waar je gegevens kunt lezen/verzenden die verband houden met een specifiek gebied. We hebben verschillende endpoints waarmee je verschillende gegevens van het platform kunt ophalen. Deze endpoints hebben betrekking op de modules van het platform, zoals bijvoorbeeld het ophalen van kandidaat gegevens uit de Recruitment module of werknemer gegevens uit de HR-module.

Endpoints en uitleg;

Wanneer je wilt communiceren met een API, gebruik je verschillende methoden, afhankelijk van wat je wilt bereiken met de gegevens. De meest gebruikte methoden zijn:

GET: Gegevens verkrijgen
POST: Creëer gegevens
PUT: Gegevens bijwerken of vervangen (deze methode kan niet worden gebruikt met de API van Emply)
PATCH: Gegevens bijwerken of wijzigen
DELETE: Gegevens verwijderen

In Emply's API werken we voornamelijk met GET, POST en DELETE methodes. De methoden verschillen per endpoint, waarbij sommige het ophalen, bijwerken en verwijderen van gegevens mogelijk maakt. Bij andere endpoints kunnen er meer of minder opties zijn, afhankelijk van de gegevens.

Een voorbeeld is ons Candidate endpoint, waarin alle functionaliteiten voor toegang tot gegevens met betrekking tot kandidaten zijn ondergebracht.

Op het Candidate endpoint zijn er drie opties;

Haal kandidaten op die na een bepaalde datum zijn aangemaakt
Kandidaat op naam ophalen
Kandidaat verwijderen

Wanneer je gegevens naar een API endpoint gaat lezen/verzenden, werk je met verzoek-antwoordmethoden. Dit betekent dat je een verzoek naar de API stuurt en vervolgens een reactie terugkrijgt. Bij het maken van een query(verzoek) moet je parameters invullen waarmee de API de database kan opzoeken voor de juiste gegevens. Een voorbeeld van in te vullen parameters op het Candidate endpoint;

Bovenstaand endpoint sorteert kandidaten op datum en zoekt in de database alleen kandidaten op die na een bepaalde datum in het systeem zijn aangemaakt. Daarom moet dit veld worden ingevuld.

Hetzelfde geldt voor de url van het klantplatform. De API is generiek en dekt alle platforms die in Emply zijn aangemaakt, maar om de juiste data op te halen, moet de API de juiste klantendatabase opzoeken.

Zodra de twee * velden zijn ingevuld, is het mogelijk om de query te versturen naar de API. De API retourneert dan een antwoord;

Een reactie van de API heeft altijd een code. Aan de hand van de code kan worden beoordeeld of de aanvraag is gelukt of dat er iets is misgegaan. Als je een code 200 ontvangt, zoals in de afbeelding hierboven, dan is het verzoek geslaagd en worden de gegevens afgeleverd. Als je daarentegen een andere code ontvangt, zoals 400 of 404, is er een fout opgetreden - er zijn bijvoorbeeld geen gegevens over de kandidaat in de database.

Om dieper in te gaan op de details van onze API, is het mogelijk om verder te lezen in onze API-artikelen, waar we doornemen hoe je met Emply's API kunt werken om een specifieke taak op te lossen: