Hur använder jag OpenAPI?

Vårt tillägg Öppet API kopplar Vacation Tracker till dina egna verktyg. Skapa en API-nyckel, välj vad den får göra och använd den för att läsa och ändra dina data eller få aviseringar när något ändras.

Så skapar du en API-nyckel

1. Logga in på ditt Vacation Tracker-konto på app.vacationtracker.io/signin.
2. Öppna Integrationer i menyn till vänster (under Arbetsplatsinställningar).
3. Klicka på kortet API. Då öppnas sidan Öppet API.
4. Klicka på Skapa API-nyckel i avsnittet API-nycklar.
5. Ange ett Nyckelnamn. Bara personer i ditt företag ser det här namnet.
6. Ange vid behov ett Integrationsnamn. Det visas i Vacation Tracker bredvid varje ändring som nyckeln gör, till exempel ”Godkänd av Jane (via Payroll sync)”. Lämna fältet tomt om bara personens namn ska visas.
7. Under Behörigheter väljer du en mall och justerar den vid behov (se nedan).
8. Under Utgång väljer du när nyckeln ska upphöra att gälla: om 30 dagar, om 90 dagar, om 1 år (rekommenderas) eller aldrig.
9. Kontrollera Sammanfattning och klicka på Skapa API-nyckel.
10. Kopiera nyckeln och förvara den på ett säkert ställe. Hela nyckeln visas bara en gång, när den skapas.

Välja behörigheter

Börja med en mall och justera den sedan:

• Endast läsning: se data, ändra ingenting. Passar för rapporter och instrumentpaneler.
• Ledighetshantering: begär, lägg till och godkänn ledigheter. Läs användare och ledighetstyper.
• Konfiguration av arbetsytan: ställ in platser, avdelningar, ledighetstyper, policyer, helgdagar och användare.
• Anpassad: välj varje behörighet själv.

Varje behörighet kan ställas in på Ingen åtkomst, Läsa eller Läsa och skriva. Att godkänna och neka ansökningar, se dolda namn på ledighetstyper och agera för andra användares räkning är separata kryssrutor, så aktivera dem bara om ditt verktyg behöver dem. En nyckel kan bara göra det som du själv får göra i Vacation Tracker.

Hantera dina nycklar

Tabellen API-nycklar listar alla nycklar i arbetsytan med ägare, behörigheter, senaste användning, utgångsdatum och status. Klicka på en nyckel för att öppna dess detaljer, där du kan:

• Se månadens användning och redigera nyckelns namn och behörigheter.
• Kontrollera Senaste aktivitet, som listar alla förfrågningar som har ändrat data.
• Klicka på Rotera nyckel för att få en ny nyckel med samma namn och behörigheter. Välj om den gamla nyckeln ska fortsätta fungera i 24 timmar (rekommenderas), i 7 dagar eller sluta fungera direkt.
• Klicka på Återkalla för att stoppa nyckeln permanent.

Vi skickar ett e-postmeddelande till dig 14 dagar innan en nyckel upphör att gälla.

Gör din första förfrågan

Bas-URL:en är https://api.vacationtracker.io/v2. Skicka din nyckel som en bearer-token i headern Authorization:

Ett lyckat anrop returnerar data under data. Listor med fler sidor innehåller också en nextToken, som du skickar tillbaka för att hämta nästa sida.

Om något går fel innehåller svaret ett error med en kod, en beskrivning och en lösning. En nyckel som saknas eller är okänd returnerar 401. En nyckel som saknar den behörighet som en förfrågan kräver returnerar 403 med INSUFFICIENT_SCOPE.

Så lägger du till en webhook

1. Gå till Webhooks på sidan för tillägget Öppet API och klicka på Hantera webhooks.
2. Klicka på Lägg till webhook.
3. Ange den Endpoint-URL som ska ta emot händelserna. Den måste använda HTTPS.
4. Under Händelser väljer du Ledighetsbeslut, All aktivitet kring ledighet, Håll en fullständig kopia synkroniserad eller Anpassad för att välja händelser själv.
5. Klicka på Lägg till webhook.

Du får bara händelser för data som du har behörighet att se.

Kvoter och hastighetsbegränsningar

Begränsningarna gäller per API-nyckel:

• Upp till 30 000 förfrågningar per månad.
• 10 förfrågningar per sekund, med tillfälliga toppar på upp till 50 förfrågningar.

Om din integration behöver mer skickar du ett e-postmeddelande till developers@vacationtracker.io med ditt företagsnamn, integrationen och den trafik du räknar med.

Vanliga frågor