Denne artikkelen er relevant for brukere som skal opprette API-nøkler for deres konto. For å kunne opprette disse nøklene i RAYVN trenger du tilgang via kontoinnstillingene. En administrator kan opprette nøkler og sende dem til de som skal bruke dem, eller så kan de opprettes og brukes av samme personer.
En API (Application Programming Interface) kan brukes for å få to eller flere forskjellige dataprogram til å kommunisere med hverandre.
Oppsett av API-koblinger skjer ikke direkte inne i RAYVN-plattformen.
For å kunne opprette API-nøkler må kontoen deres ha en API-modul. Denne kommer utenom den ordinære pakken med funksjonaliteter man finner i RAYVN, da ikke alle har behov for dette.
Hvordan opprette API-nøkler i kontoen
Dersom dere har API-modulen i kontoen deres, kan du opprette API-nøkler i kontoinnstillingene.
Merk at kontoinnstillingene kun er tilgjengelige for brukere med tilgangsnivå "Kontoadmin" eller "Gruppeadmin".
Når du er i kontoinnstillingene, kan du trykke på gruppenavnet øverst på venstre side, og velge "Rediger API-nøkler".
Du vil da komme til et nytt vindu hvor du kan se alle eksisterende API-nøkler i kontoen deres, og et felt hvor du kan opprette nye nøkler.
Du kan opprette en ny nøkkel ved å gi den et navn, og velge en utløpsdato. Det er valgfritt å velge en utløpsdato for nøkkelen, og om du ikke velger å gjøre dette, vil nøkkelen vare frem til den slettes.
Når du trykker "Opprett nøkkel", vil du se at denne nøkkelen legges til i listen over aktive nøkler, og du kan også se hvem som har opprettet nøklene.
Klikk på kopi-symbolet for å kopiere nøkkelen, slik at du kan bruke den i API-et.
Øverst i vinduet for å opprette nøkler, vil du finne lenken som tar deg til RAYVN-APIet. Dette er lokalisert i Swagger.
Swagger er et åpent ressurssett med regler, spesifikasjoner og verktøy for utvikling og beskrivelse av REST API-er.
API-dokumentasjonen er som en referansemanual som inneholder instruksjoner om hvordan man effektivt bruker og integrerer med et API.
I Swagger kan du utføre CRUD-operasjoner på brukere, respondere, kontakter, kontaktlister og team.
Denne dokumentasjonen er ment for teknisk personell.Dette er vår tekniske API-dokumentasjon der du lagrer API-nøkkelen som opprettes i RAYVN.
Velg knappen som heter "Authorize".
Lim inn den nøkkelen du kopierte tidligere, velg "Authorize", og lukk dialogen.
Nå har du lagt inn nøkkelen, og kan begynne å arbeide med APIet.