Hvordan opprette og fjerne API-nøkler
Opprett en public eller secret API-nøkkel, kopier den og deaktiver nøkler som ikke skal brukes.
Hva er en API-nøkkel, og når trenger du den?
Et API er en måte dataprogrammer kan kommunisere med hverandre på. En API-nøkkel er en verdi en integrasjon bruker i tilkoblingen til organisasjonen din. Dette er aktuelt når et annet system eller en nettside skal bruke en integrasjon som ber om en nøkkel; du trenger ikke en API-nøkkel for å arbeide vanlig i administrasjonspanelet.
Public key er laget for bruk på brukersiden av en integrasjon. Secret key er hemmelig og skal bare brukes på serveren. Velg typen integrasjonen ber om, og behandle en hemmelig nøkkel som et passord. Å opprette nøkkelen setter ikke opp selve integrasjonen automatisk.
Bare en organisasjonseier kan administrere nøklene. Enkelte etiketter på denne siden står på engelsk også når resten av panelet er på norsk.
Opprett en nøkkel
-
Åpne Innstillinger i sidemenyen.
-
Velg fanen API-nøkler.
-
Finn kortet API keys.
-
Trykk New key.
-
Velg Key type: Public key eller Secret key etter integrasjonens behov.
Public key er laget for integrasjoner som trenger en offentlig nøkkel på brukersiden. Secret key skal bare brukes på serveren og behandles som et passord. Følg kravene til integrasjonen; ikke legg en Secret key i offentlig nettsidekode.
-
Skriv en gjenkjennelig Description.
Skriv hva nøkkelen brukes til, for eksempel «Påmeldingsskjema på hovednettsiden» eller «Intern integrasjon». Beskrivelsen gjør det lettere å finne riktig nøkkel når dere senere skal rydde eller bytte integrasjon.
-
Les informasjonen om nøkkeltypen.
-
Trykk Create.
-
Trykk Copy key i resultatdialogen.
-
Lagre nøkkelen sikkert. En Secret key vises bare i sin helhet nå.
Lagre en Secret key et sted dere bruker til hemmeligheter, for eksempel en passordbehandler eller integrasjonens sikre konfigurasjon. Etter at resultatdialogen er lukket, vises ikke hele den hemmelige nøkkelen igjen.
-
Trykk Close når nøkkelen er tatt vare på.
-
Legg nøkkelen inn i integrasjonen. Selve integrasjonen settes opp utenfor denne siden.
Å opprette nøkkelen gir deg en verdi å bruke i integrasjonen. Det kobler ikke automatisk sammen et annet system eller installerer noe på nettsiden.
-
Kontroller tilkoblingen i integrasjonen.
Fjern en nøkkel
-
Finn nøkkelen i API keys.
-
Kontroller beskrivelsen og nøkkeltypen.
-
Undersøk hvilke integrasjoner som bruker nøkkelen før du fjerner den.
Hvis samme nøkkel brukes av et nettsted eller et annet system, kan tilkoblingen stoppe når nøkkelen deaktiveres. Finn derfor bruken før du fjerner nøkkelen.
-
Trykk sletteikonet ved nøkkelen.
-
Les Delete API key.
-
Trykk Delete hvis nøkkelen skal deaktiveres. Bruk Cancel hvis du vil avbryte.
Delete deaktiverer nøkkelen. Bruk Cancel hvis du bare ville undersøke hvilken nøkkel dette var og vil beholde tilkoblingene som bruker den.
Behandle en Secret key som et passord. Den skal bare brukes på serversiden, og skal ikke legges i nettleserkode, offentlige skjermbilder eller en hjelpesak.