Oversigt over Salary's API
API'et understøtter to overordnede scenarier:
Direkte brugeradgang – En bruger tilgår API'et med sin egen API-nøgle.
Virksomhedsintegration – En ekstern virksomhed eller et system tilgår API'et på vegne af en bruger via en API-client.
1. API-nøgler
Alle brugere kan selv oprette API-nøgler direkte i systemet. En API-nøgle giver adgang til at læse og skrive data på brugerens vegne.
Oprettelse af en API-nøgle
API-nøgler oprettes ved at autentificere sig med brugernavn og adgangskode. Det er den eneste måde at få udstedt en nøgle på – der er ingen anden autentificeringsmetode tilgængelig.
Vigtigt: Opbevaring din API-nøgle sikkert. Den giver fuld læse- og skriveadgang til dine data.
2. API-client (til virksomheder)
Virksomheder, der ønsker at bygge integrationer til systemet, kan ansøge om en API-client. En API-client fungerer som virksomhedens adgangsidentitet i systemet.
En API-client alene giver ikke adgang til bruger- eller virksomhedsdata. For at tilgå data skal klienten kombineres med en eller flere API-nøgler.
Sådan fungerer det
Komponent | Formål |
API-client | Identificerer den integrerende virksomhed |
API-nøgle | Giver adgang til en specifik brugers/virksomheds data |
API-clienten medsender altså API-nøglen i sine kald for at specificere, hvilken bruger eller virksomhed der tilgås. Det er muligt at medsende flere API-nøgler, hvis integrationen skal have adgang til data på tværs af flere virksomheder.
3. Integration med Salary
Virksomheder, der bygger integrationer direkte mod Salary, skal anvende begge komponenter:
En API-client – udstedt til den integrerende virksomhed.
Brugerens API-nøgle – udstedt af den Salary-bruger, som integrationen skal handle på vegne af.
Brugeren opretter selv sin API-nøgle (via brugernavn og adgangskode) og deler den med den integrerende virksomhed, som derefter inkluderer nøglen i sine API-kald sammen med sin API-client.
4. API Dokumentation
Salarys API er dokumenteret og kan findes her.
Opsummering
Bruger → Logger ind med brugernavn + adgangskode → Opretter API-nøgle (læse/skrive adgang)
Virksomhed med integration → Har en API-client (virksomhedens identitet) → Medsender API-nøgle i kald → Tilgår én eller flere brugeres/virksomheders data
Kom godt i gang
Log ind i systemet med dit brugernavn og din adgangskode.
Opret en API-nøgle under dine kontoindstillinger.
Har du brug for en API-client til en virksomhedsintegration? Kontakt os for at få oprettet en.
API'et er dokumenteret her.