Inleiding tot JSON-export in Emply
Met de JSON-exportfunctionaliteit in Emply bepaal je zelf welke gegevens worden opgenomen. Dit biedt je de flexibiliteit om uitsluitend relevante data te exporteren naar andere systemen, zonder overbodige informatie mee te sturen.
Een JSON-export is een momentopname van een profiel op het moment van export. Zijn er nadien wijzigingen? Dan moet je een nieuwe export uitvoeren om de bijgewerkte data te ontvangen.
Je kunt handmatig exporteren of automatische exports instellen op een gepland tijdstip, bij wijzigingen in gegevens of bij toevoeging van nieuwe informatie. Dit stel je eenvoudig in via de automatiseringsinstellingen van Emply.
- Ga naar Instellingen > Integraties > Exporteren.
- Klik op + Nieuwe export en kies JSON pakket.
- Geef de export een interne naam en kies of deze van toepassing is op Werknemer en/of Kandidaat.
- Selecteer de dynamische velden die je in het JSON-bestand wilt opnemen.
- Kopieer de unieke GUID onderaan het JSON-pakket.
- Ga naar de relevante vacature en selecteer de kandidaten.
- Klik op het hamburgermenu > Exporteren.
- Selecteer de juiste JSON-export > klik op Exporteren.
- Verkrijg je API-sleutel via Instellingen > Integraties > API. Zoek de actieve sleutel en kopieer deze naar je klembord.
- Ga naar de API-indexpagina van Emply.
- Klik op Authorize en plak je API key onder Value.
- Voer een GET-verzoek uit naar:
/v1/{customer}/exports/{exportId}
- exportId = GUID uit de exportinstellingen
- customer = Eerste deel van het platformdomein, bijvoorbeeld 'klantnaam.emply.com'
- languageKey = (optioneel) bij meertalige exports
- from/to = Tijdvak voor de export
- Voer een GET-verzoek uit naar:
/v1/{klant}/exports/{exportId}om een lijst met entiteiten op te halen. - Gebruik de entiteits-ID in:
/v1/{customer}/exports/{exportId}/entities/{entityId}om per entiteit gegevens op te halen. - Verwerk of bewaar de gegevens zoals gewenst.
- Voer stap 2 en 3 uit voor elke entiteit in de lijst die je in stap 1 hebt opgehaald.
Zodra je het gewenste resultaat hebt getest, kun je de API-stroom ook integreren in je eigen systeem. De stappen zijn identiek aan de testprocedure:
- Haal de lijst met entiteiten op met:
/v1/{klant}/exports/{exportId}. - Gebruik elke entiteits-ID in:
/v1/{customer}/exports/{exportId}/entities/{entityId}. - Bewaar of verwerk de entiteitsgegevens.
- Herhaal dit voor alle entiteiten in de opgehaalde lijst.