Om API-Modulen
Et API (application programming interface) gjør det mulig for ulike systemer å kommunisere med hverandre. Dette betyr at informasjon kan overføres mellom RAYVN og andre systemer automatisk, uten at man må legge inn den samme informasjonen manuelt begge steder.
Med RAYVNs API-modul kan du koble RAYVN sammen med andre systemer organisasjonen din allerede bruker. Du kan for eksempel bruke den til å holde brukere, kontakter og annen informasjon automatisk oppdatert.
Hvorfor bruke API-modulen?
Her er noen eksempler på hvordan API-et kan brukes:
- Hold brukere og kontakter oppdatert fra et annet system, for eksempel et HR-system, Entra ID/Active Directory, eller et personalregister. Dette betyr at du slipper å registrere og oppdatere de samme personene manuelt i flere systemer.
- Hent ut data fra logger og hendelser, inkludert oppføringer, deltakere og status, til bruk i egne rapporterings- eller analyseverktøy.
- Hold kontaktlister oppdatert fra et eksternt system, slik at kontaktinformasjonen i RAYVN holder seg oppdatert.
Den viktigste fordelen er at det kan spare tid og redusere mengden manuelt arbeid. Det kan også bidra til å sikre at informasjonen i RAYVN holdes oppdatert.
API-modulen er en egen tilleggsmodul og er ikke inkludert i standardoppsettet til RAYVN. Det er en ekstra kostnad for modulen. Ta kontakt med oss dersom du ønsker å aktivere den for kontoen din.
Hvordan komme i gang
Når API-modulen er aktivert for kontoen din, kan du opprette en API-nøkkel og sette opp integrasjonen ved hjelp av instruksjonene i "Hvordan aktivere API-nøkler i RAYVN".
Dette er et godt sted å starte når du skal sette opp en integrasjon. For mer informasjon om selve endepunktene og datamodellene, ta kontakt med oss for å få tilsendt Customer Instructions.
Ofte stilte spørsmål
Hva koster API-modulen?
API-modulen har en ekstra kostnad utover standard RAYVN-pakken. Ta kontakt med oss for pris.
Hvilke tilgang har API- nøkkelen?
Alle API-kall krever en API-nøkkel som er knyttet til en bruker i kontoen din. Per i dag gjelder en API-nøkkel på gruppenivå.
Finnes det et test- eller sandkassemiljø?
Nei, det finnes for øyeblikket ikke et eget test- eller sandkassemiljø. API-kall gjøres mot de faktiske dataene i kontoen din.
Ønsker du å teste en integrasjon uten å påvirke dine vanlige brukere eller logger, anbefaler vi å opprette en egen testgruppe i kontostrukturen, og opprette en egen API-nøkkel fra denne gruppen. Nøkkelen vil da kun ha tilgang til testgruppen og eventuelle undergrupper av den, ikke resten av kontoen.
Kan RAYVN varsle systemet vårt automatisk når noe skjer (webhooks)?
Nei. API-et fungerer i dag ved at systemet ditt henter informasjonen fra RAYVN. Det finnes for øyeblikket ingen mekanisme for at RAYVN sender automatiske varsler til systemet ditt.
Er API-et det samme som SCIM eller automatisk brukerprovisjonering?
Nei. SCIM er en egen integrasjon som brukes til automatisk brukerprovisjonering, for eksempel gjennom Entra ID, men SCIM-integrasjonen er inkludert i API-modulen. Les mer i artikkelen "Om SCIM integrasjonen".
Dekker API-et all funksjonalitet i RAYVN?
Nei, men API-et dekker i dag kjernefunksjonalitet som brukere, respondenter, kontakter og kontaktlister, grupper og team, steder og ressurser, maler, filer, logger og meldinger.
Leter du etter en bestemt funksjon og er usikker på om den er tilgjengelig via API-et, ta gjerne kontakt med oss, eller se Customer Instruction.