Emplys API
Emply har et API, hvori der er adgang til data fra platformen. Det bruges blandt andet til at hente data til andre systemer. For at benytte sig af Emplys API, skal man oprette en API key på sin Emply platform. Dette gøres ved at gå ind på Indstillinger > Integrationer > API > klik på ‘Ny API key’.
Angiv en titel og klik Gem for at fortsætte.
Derefter får du overblikket over den genererede API-nøgle, samt Client secret key. Derudover skal der vælges en eller flere roller som har adgang til denne API-nøgle, samt aktivere den, før man kan gøre brug af API-nøglen i Emplys API. Afslut ved at klikke Gem.
Når API-nøglen er oprettet, findes den under API, og du er nu klar til gøre brug af Emplys API: https://api.emply.com/.
Der er mange muligheder for at hente og sende data med API’et gennem forskellige endpoints. Et endpoint er en lokation, hvor man kan læse/sende data, der relaterer sig til et specifikt område. Et eksempel er vores Candidate endpoint, hvori alle funktionaliteter til at tilgå data relateret til kandidater ligger.
På Candidate endpointet er der tre muligheder;
- Hent kandidater oprettet efter en specifik dato
- Hent kandidat på navn
- Slet kandidat
Når man skal læse/sende data til et API endpoint arbejder man med request-response metoder. Det betyder, at man sender en forespørgsel til API’et og så modtager man et svar retur. Når man skal lave en forespørgsel skal man udfylde parametre, der gør det muligt for API’et at slå op i databasen efter de rigtige data. Et eksempel på parametre, der skal udfyldes på Candidate endpointet;
Ovenstående endpoint sorterer kandidater efter dato og slår kun op i databasen efter kandidater, der er blevet oprettet i systemet efter en specifik dato. Derfor skal dette felt udfyldes. Det samme gælder for kundens platform url. API’et er generisk og dækker alle platforme oprettet i Emply, men for at hente de rigtige data, skal API’et slå op i den rigtige kundedatabase.* Når de to felter er udfyldt er det muligt at sende forespørgslen (request) til API’et. API’et vil herefter returnere et svar (response);
Et response fra API’et vil altid have en kode. På baggrund af koden kan man vurdere om forespørgslen er gået igennem eller om noget er gået galt. Hvis man som i ovenstående billede modtager en code 200, så er forespørgslen gået i gennem og data leveres. Hvis man derimod modtager en anden kode som 400 eller 404, så er der sket en fejl - eksempelvis kan det være, at der ikke ligger nogle data på kandidaten i databasen.
*Der kan ikke oprettes forbindelse til andre kundeplatforme end dem, brugeren har rettighed til at hente data fra. For at få adgang til data fra Emply, skal man oprette en API nøgle i platformen. Det er bygget op på den måde for at sikre, at der kun er adgang til data for admins/ IT brugere fra den pågældende platform.
Hvilke data kan man hente fra Emply’s API?
Vi har en del endpoints, hvor man kan hente forskellige data fra platformen. Vores endpoints relaterer sig til de forskellige moduler i platformen som eksempelvis i vores eksempel ovenfor med kandidater, der henter data fra rekrutteringsmodulet. Vi har også employees endpoint, der henter data fra HR modulet og exports, der henter eksportfiler opsat i eksportmenuen.
Endpoints og forklaring;
Når man skal kommunikere med et API, bruger man forskellige metoder alt efter, hvad man ønsker at opnå med data. De mest gængse metoder, der bruges er;
- GET: Hent data
- POST: Opret data
- PUT: Opdater eller erstat data (Denne metode kan ikke bruges med Emply’s API)
- PATCH: Opdater eller modificer data
- DELETE: Slet data
I Emply's API arbejder vi primært med GET, POST og DELETE metoder. Metoderne varierer ved hvert endpoint, hvor ved nogle er det muligt både at hente, opdatere og slette data. Ved andre kan der være færre muligheder alt efter, hvilket data der er tale om.
For at dykke yderligere ned i detaljen omkring vores API er det muligt at se vores dokumentation på vores endpoints her. Der er også mulighed for at læse yderligere i vores API artikler, hvor vi gennemgår, hvordan du kan arbejde med vores API for at løse en konkret opgave: