Exportbestand maken - JSON pakket

Het volgende is een inleiding tot het gebruik van JSON in de exportfunctionaliteit van Emply.

De gegevens die in een JSON-export moeten verschijnen, zijn door de gebruiker gedefinieerd, daarom is het mogelijk om pulls in te stellen met precies de gegevens die u nodig hebt, naar andere systemen, zonder dat u gegevens hoeft te omzeilen die niet nodig zijn.

De gegevens in een JSON-export moeten worden gezien als een "snapshot", genomen van een profiel bij de laatste uitvoering van de export. Zorg er daarom voor dat u uw export opnieuw uitvoert als u bijgewerkte gegevens wilt.

Het uitvoeren van een export kan handmatig worden gedaan, automatisch op een bepaald tijdstip of automatisch wanneer er wijzigingen worden aangebracht - of wanneer er gegevens op profielen worden aangemaakt. Dit wordt ingesteld en aangepast door de gebruiker met behulp van de automatiseringsmethoden van Emply.

Hoe maak ik een JSON-export aan?

Ga naar Instellingen > Integraties > Exporteren > klik op '+ Nieuwe export' > selecteer 'JSON pakket'.

Hier geeft u de export een interne omschrijving en kiest u of deze gebruikt moet worden voor 'Werknemer' en/of 'Kandidaat'.

Hieronder selecteert u de dynamische tekst die de gegevens vertegenwoordigen die u wilt ophalen met uw JSON-export.

Hoe een JSON-export gebruiken?

Nadat u de gewenste velden heeft ingevuld, kopieert u de unieke GUID onderaan uw JSON-pakket en houd deze bij de hand:

Vervolgens moet u een export maken van de medewerkers en/of kandidaten waarvan u 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 uw API-sleutel en ga naar de API-indexpagina van Emply. Verifieer uzelf 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 u een specifieke vertaling van de gegevens wilt ophalen.
• from/to = tot en vanaf datum van export.

Wanneer de gegevens zijn geladen, krijgt u 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:

1. Haal de lijst met entiteiten op die in de geselecteerde tijdsperiode worden uitgevoerd met endpoint: /v1/{klant}/exports/{exportId}.
2. Gebruik de entiteits-ID en endpoint: /v1/{customer}/exports/{exportId}/entities/{entityId} om de gegevens in de export te zien.
3. Bewaar/verwerk entiteitsgegevens zoals gewenst.
4. Herhaal stap 2 en 3 voor elke entiteit die wordt weergegeven in stap 1.