SOAP API er en webservice API. Dette betyr at API er tilgjengelig på internett og synlig for alle som ønsker å se det. API brukes ved å skrive programvare som kobler seg til det og interagerer med API. For å integrere med Severa, trenger du en API-nøkkel. Uten den er bruk av API ikke mulig. Så selv om API i seg selv er offentlig, er bruken begrenset til organisasjoner som har Severas API-tillegg aktivert og som har opprettet og aktivert API-nøkkelen i integrasjonsprogrammet.
Kort sagt, trinnene som kreves for integrasjon er:
Definer behovene for integrasjonen. Er det for eksempel behov for å legge inn arbeidstimer eller overføre fakturaer?
Sjekk om SOAP API har nødvendige grensesnitt og alternativer for integrasjonen. Bruk API-dokumentasjonen sammen med Severa-miljøet for å få nødvendig informasjon.
Hvis du integrerer med en annen programvare, sjekk også at det er en API eller en annen måte for ønsket interaksjon på den andre siden.
Hvis alt ser bra ut, opprett programvare som kobler seg til API og utfører integrasjonen. Det er ofte nødvendig med en server der integrasjonen kjører. Det anbefales også å overvåke og logge eventuelle integrasjonsfeil.
SOAP API er passiv, noe som betyr at integrasjonsprogramvaren må kalle API for å utføre en funksjon og vente på API-svaret for å se om det var vellykket.
Klikk her for mer informasjon og veiledning (Kun på engelsk).
API: n aktivering for organisasjonen din
For å kunne integrere med Severa, må du aktivere API i Severa-organisasjonen din.
Vi anbefaler å opprette en API-bruker i Severa som ikke er en timebruker i den aktuelle organisasjonen. Dette er av to grunner:
Det er nødvendig å gi API-nøkkelen til en bruker med omfattende rettigheter i Severa, fordi det er viktig å få riktig informasjon ut av programmet. All data hentet fra API er begrenset av brukerens tilgangsrettigheter, som API-nøkkelen er i bruk for.
Når API-brukeren ikke er en timebruker i organisasjonen, er det ikke så mye behov for å holde oversikt over hvem som har API-nøkkelen i bruk, og hva denne brukerens rettigheter er eller om denne brukeren fortsatt er ansatt i selskapet. For at integrasjoner skal fungere, må API-brukeren være aktiv hele tiden, så hvis API-nøkkelen er opprettet for en bestemt timebruker, vil integrasjonen slutte å fungere hvis brukeren blir inaktivert.
Når API-brukeren er opprettet og API aktivert, genereres en API-nøkkel for brukeren. Denne API-nøkkelen er i bruk i integrasjonsprogramvaren og identifiserer API-kalleren og brukerens organisasjon, og sikrer at data returneres riktig.
Hvis API-nøkkelen for brukeren fornyes, må den oppdateres i programvaren som integreres med Severa.
Denne artikkelen har blitt oversatt ved hjelp av et AI-basert oversettelsesverktøy. Innholdet eller formuleringen av disse instruksjonene kan avvike fra de i andre instruksjoner eller i programvaren.