Applikasjonsnøkkel og klientnøkkel
Når en ekstern part får tilgang til PowerOffice Go sitt API, oppretter API-teamet en integrasjon i PowerOffice sine interne systemer. Integrasjonen tildeles et navn, og det settes rettigheter og tilganger til de funksjonene integrasjonen trenger. Integrasjonen knyttes til en unik applikasjonsnøkkel — en fast nøkkel som identifiserer applikasjonen og eieren av integrasjonen. Applikasjonsnøkkelen kan sammenlignes med et brukernavn.
Applikasjonsnøkkelen alene gir ikke tilgang til noe. Før integrasjonen kan brukes, må den aktiveres på en klient i PowerOffice Go — av kunden selv eller en bruker med tilgang på klienten. Når integrasjonen aktiveres, genereres det en unik klientnøkkel.
🔗 Les hvordan du legger til en API-integrasjon i PowerOffice Go
Hva er klientnøkkelen?
Klientnøkkelen er unik for hver aktiverte integrasjon på hver enkelt klient. Hvis den samme integrasjonen — for eksempel «Prima Kassasystem» — aktiveres på to ulike PowerOffice Go-klienter, vil integrasjonen ha én unik klientnøkkel per klient. Klientnøkkelen fungerer som et passord: integrasjonsparten bruker kombinasjonen av applikasjonsnøkkel og klientnøkkel for å kommunisere med den aktuelle klienten via API.
Klientnøkkelen skal behandles som et passord — oppbevar og overlever den på en sikker måte.
Maskering av klientnøkkelen
Fordi klientnøkkelen er sensitiv, maskeres den i PowerOffice Go umiddelbart etter at en integrasjon er aktivert. Den kan ikke hentes frem igjen — verken av kunden eller av PowerOffice. Det er derfor viktig å kopiere klientnøkkelen første gang integrasjonen aktiveres, mens dialogen for prosessen fortsatt er åpen.
Hvis klientnøkkelen går tapt, kan integrasjonen fjernes og aktiveres på nytt. Da genereres en ny unik klientnøkkel, som må formidles til integrasjonsparten og erstatte den gamle.
Slik fungerer API-kommunikasjonen
Forholdet mellom applikasjonsnøkkel og klientnøkkel tilsvarer forholdet mellom brukernavn og passord. Når en integrasjon aktiveres på en klient i PowerOffice Go, legges det i praksis til en «bruker» som representerer integrasjonspartens applikasjon. For at denne brukeren skal kunne kommunisere mot klienten via API, trenger den klientnøkkelen som «passord».
Illustrasjonen nedenfor viser API-kommunikasjonen mot PowerOffice Go sammenlignet med hvordan en vanlig bruker kommuniserer via nettleser.
🔗 Teknisk beskrivelse av API-autentisering i PowerOffice Go (developer.poweroffice.net)
Ofte stilte spørsmål
Hva er forskjellen på applikasjonsnøkkel og klientnøkkel?
- Applikasjonsnøkkelen identifiserer selve integrasjonen og eieren av den — den er fast og fungerer som et brukernavn. Klientnøkkelen genereres når integrasjonen aktiveres på en spesifikk PowerOffice Go-klient, og fungerer som passordet for kommunikasjon mot den klienten. Begge nøklene trengs for at integrasjonen skal kunne bruke API-et.
Kan jeg se klientnøkkelen i etterkant?
- Nei. Klientnøkkelen maskeres i PowerOffice Go umiddelbart etter aktivering og kan ikke hentes frem igjen. Kopier nøkkelen første gang du aktiverer integrasjonen, mens dialogboksen fortsatt er åpen.
Hva gjør jeg hvis klientnøkkelen er tapt?
- Fjern integrasjonen fra klienten og aktiver den på nytt. Da genereres en ny unik klientnøkkel. Husk å formidle den nye nøkkelen til integrasjonsparten, som må erstatte den gamle i sitt system.
Vil den samme integrasjonen ha samme klientnøkkel på to ulike klienter?
- Nei. Klientnøkkelen er alltid unik per klient. Hvis samme integrasjon aktiveres på to ulike PowerOffice Go-klienter, får hver klient sin helt egne klientnøkkel.