Öppet API | Evitys hjälpcenter

Evitys öppna API låter era egna system hämta och uppdatera uppgifter i Evity: medarbetare, anställningar, löner, team, platser, frånvaro och scheman. Du behöver det när ett annat system ska läsa från eller skriva till Evity utan att någon gör det för hand.

Slå på funktionen

Den som ska hantera API-nycklar behöver behörigheten Kan hantera API-modulen. Med den syns Öppet API under Inställningar i menyn.
Ingen annan inställning behövs. Det som styr vad ett annat system får göra är nyckelns egna rättigheter, som du sätter i nästa steg.

Skapa en API-nyckel 🔑

Lägg till en nyckel.

Gå till Inställningar → Öppet API och tryck Lägg till åtkomsttoken.
Visa API-referenser öppnar referensen med alla anrop. Den behöver den som ska koppla systemet.

Namn, nyckel och rättigheter.

Ge nyckeln ett namn under Api-användarnamn, gärna systemet den ska användas av.
Klicka för att få nyckeln visar nyckeln så att du kan kopiera den. Det går att göra nu eller senare, och den kan visas igen.
Slå på de rättigheter nyckeln ska ha. Åtkomst till organisationsuppgifter ger team och platser. Åtkomst till medarbetaruppgifter öppnar medarbetaruppgifterna, och under den väljer du del för del: personuppgifter, bank, anställning, lön, roller, egna fält. Varje del har en egen Uppdatera-rättighet för att få ändra, så en nyckel kan läsa utan att få ändra. Kalender, semester, frånvaro och schema har egna rättigheter längst ner.

Vilka medarbetare, och spara.

Under Inkluderade anställda bestämmer du vilka medarbetare nyckeln ser. Utan val gäller All personal.
Tryck Klart.

Tips. Skapa en nyckel per system och ge den bara det systemet behöver. En nyckel som bara ska läsa behöver inga Uppdatera-rättigheter.

Använda API:et

Alla anrop går till https://api.evity.hr. Skicka nyckeln i rubriken X-Api-Key på varje anrop.
Alla endpoints, med exempel på svar, finns i API-referensen. Du når den också via Visa API-referenser på sidan Öppet API.
Listor med medarbetare är sidindelade. Svaret innehåller en länk till nästa sida tills den är tom.

Följa upp

Alla nycklar syns i listan på sidan Öppet API, med vilka medarbetare varje nyckel når. Öppna en nyckel för att ändra rättigheter eller ta bort den med Ta bort.
Vill ni få besked när något ändras i Evity, ange en adress under Url för notifikationer. Evity skickar då en notis när en medarbetare, lön, frånvaro, ett team eller en plats ändras. Läs mer om Webhook-händelser visar vilka händelser som skickas.
Delad nyckel längst ner är det ni kontrollerar webhook-anropen med, så att ni vet att de kommer från Evity.

Vanliga frågor

Varför får jag svaret "Unauthorized"?

Antingen saknas rubriken X-Api-Key, nyckeln är fel kopierad, eller så saknar nyckeln rättigheten för just det anropet. Kontrollera nyckelns rättigheter under Inställningar → Öppet API.

Kan en nyckel bara se vissa medarbetare?

Ja. Under Inkluderade anställda på nyckeln väljer du ett urval, till exempel ett team eller en plats. Nyckeln ser då bara de medarbetarna i alla anrop.

Hur vet jag att en webhook kommer från Evity?

Varje notis har rubriken X-Checksum. Den är en signatur av meddelandet med den Delad nyckel som visas på sidan Öppet API. Räkna fram samma signatur på er sida och jämför.

Kan jag ändra löner eller skapa medarbetare via API:et?

Ja, om nyckeln har rättigheten för det: Uppdatera lönedetaljer respektive Skapad profil. Rättigheterna för att skriva ligger under motsvarande läsrättighet på nyckeln.

Relaterade artiklar