Het volgende is een inleiding tot het gebruik van JSON in de exportfunctionaliteit van Emply.
De gegevens die in een JSON-export worden opgenomen, worden door de gebruiker zelf bepaald. Dit biedt de flexibiliteit om precies de benodigde data te selecteren en te exporteren naar andere systemen, zonder onnodige informatie mee te sturen.
Een JSON-export kan gezien worden als een "momentopname" van een profiel op het moment dat de export plaatsvindt. Als er sindsdien gegevens zijn gewijzigd en je deze geüpdatet wilt hebben in je export, moet je de export opnieuw uitvoeren.
Het exporteren kan handmatig gebeuren, maar ook automatisch op een vooraf ingesteld tijdstip, bij wijzigingen in de gegevens of wanneer er nieuwe gegevens aan profielen worden toegevoegd. Dit kan door de gebruiker eenvoudig worden ingesteld via de automatiseringsfuncties van Emply.
Hoe maak ik een JSON-export aan?
Ga naar Instellingen > Integraties > Exporteren > klik op '+ Nieuwe export' > selecteer 'JSON pakket'.
Hier geef je de export een interne omschrijving en kies je of deze gebruikt moet worden voor 'Werknemer' en/of 'Kandidaat'.
Hieronder selecteer je de dynamische tekst die de gegevens vertegenwoordigen die je wilt ophalen met jouw JSON-export.
Hoe een JSON-export gebruiken?
Nadat je de gewenste velden heeft ingevuld, kopieer je de unieke GUID onderaan jouw JSON-pakket en houd deze bij de hand:
Vervolgens moet je een export maken van de medewerkers en/of kandidaten waarvan je de gegevens wilt ophalen.
Ga naar de vacature waarin de kandidaten zich bevinden > selecteer de gewenste kandidaten > druk op het hamburgermenu en selecteer 'Exporteren':
Selecteer gewenste JSON-export > druk op 'Exporteren':
Het JSON-pakket testen
Verkrijg nu jouw API-sleutel en ga naar de API-indexpagina van Emply. Verifieer jezelf door op 'Authorize' te klikken en onder 'Value' je API key in te vullen.
Selecteer vervolgens endpoint 'Exports' en voer eerst een GET-verzoek uit met endpoint /v1/{customer}/exports/{exportId}.
- exportId = GUID die te vinden is in de exportinstellingen.
- customer = Het eerste deel van het platformdomein, bijvoorbeeld: voorbeeld.klantnaam.com, heeft het woord 'voorbeeld' als customer.
- languageKey = Niet nodig, wordt gebruikt als de export in meerdere talen is ingesteld en je een specifieke vertaling van de gegevens wilt ophalen.
- from/to = tot en vanaf datum van export.
Wanneer de gegevens zijn geladen, krijg je een entiteit voor elke kandidaat waar de export binnen de geselecteerde tijdsperiode is uitgevoerd. Een entiteit in deze functie bestaat uit 3 waarden:
- ID = De entiteits-ID van het geëxporteerde profiel. De entiteits-ID wordt gemaakt bij de eerste uitvoering van de export en verandert niet. Bij toekomstige uitvoeringen van de export worden de gegevens die aan deze entiteits-ID zijn gekoppeld, bijgewerkt.
- Created = Datum en voor de laatste export van de entiteit. Dit is de datum en tijd die gelezen zullen worden in de from/to parameter.
- LanguageKey = De taal waaruit deze entiteit gegevens haalt.
Om de gegevens in een entiteit te lezen, moet een GET-verzoek worden uitgevoerd met endpoint v1/{customer}/exports/{exportId}/entities/{entityId}.
- exportId = GUID die te vinden is in de exportinstellingen.
- entityId = De 'ID'-waarde van een entiteit die is opgehaald in de vorige call.
- customer = Het eerste deel van het platformdomein, bijvoorbeeld: voorbeeld.klantnaam.com, heeft het woord 'voorbeeld' als customer.
Vervolgens worden de gegevens die voor de export zijn ingesteld, weergegeven in JSON format, als de gegevens zijn ingevuld op het profiel waarop de export wordt uitgevoerd.
Hoe u uw JSON-pakket gebruikt met Emply's API
Zodra het gewenste resultaat is verkregen na het testen, kan het programmeren van de eigenschappen worden gedaan, de methode zou op dezelfde manier werken als bij het testen met deze stroom:
- Haal de lijst met entiteiten op die in de geselecteerde tijdsperiode worden uitgevoerd met endpoint: /v1/{klant}/exports/{exportId}.
- Gebruik de entiteits-ID en endpoint: /v1/{customer}/exports/{exportId}/entities/{entityId} om de gegevens in de export te zien.
- Bewaar/verwerk entiteitsgegevens zoals gewenst.
- Herhaal stap 2 en 3 voor elke entiteit die wordt weergegeven in stap 1.