Integrasjon: Applikasjonsnøkkel og klientnøkkel

Når en ekstern part får tilgang til api'et, vil api teamet rent teknisk opprette en ny integrasjon i PowerOffice sine interne systemer. Basert på informasjon fra ekstern part gir vi integrasjon et navn, og vi setter rettigheter og tilganger til de funksjoner som integrasjonen trenger for å fungere som tiltenkt. Integrasjonen vi oppretter vil knyttes til sin egen unike nøkkel som kalles for en applikasjonsnøkkel. Denne nøkkelen er fast, og knyttet til applikasjonen og eieren av integrasjonen. Nøkkelen kan sammenlignes med og anses som et brukernavn.

Applikasjonsnøkkelen alene kan ikke benyttes til noe av integrasjonsparten. Først må den aktuelle integrasjonen aktiveres på en klient i PowerOffice - av kunden selv eller en bruker med tilgang på klienten, og da vil det genereres en unik klientnøkkel. Beskrivelse av hvordan en integrasjon legges til finnes i denne artikkelen.

Klientnøkkelen er helt unik for hver aktiverte integrasjon, så dersom den samme integrasjonen , eksempelvis "Prima Kassasystem", aktiveres på to ulike PowerOffice klienter, vil integrasjonen ha hver sin helt unike klientnøkkel for den enkelte klient. Klientnøkkelen er altså å anse som passordet som integrasjonsparten må bruke, når de skal kommunisere via api mot den enkelte klient som har valgt å aktivere integrasjonen.

Beskrevet på en annen måte: Når en integrasjon aktiveres i PowerOffice, legger man i praksis til en "bruker", og denne brukeren er integrasjonspartens integrasjon. For at denne "brukeren" skal kunne kommunisere mot klienten via api, trenger den også et "passord" for å gjøre det, da i form av klientnøkkelen. Det er derfor viktig at klientnøkkelen behandles som et passord - en hemmelighet som oppbevares og overleveres på en trygg måte.

En teknisk beskrivelse av autentiseringen finnes her.

Maskering av nøkler

Fordi klientnøkkelen er å anse som nettopp en hemmelighet, blir den maskert i PowerOffice etter at en integrasjon er lagt til - og den vil aldri kunne hentes fram igjen verken av kunder eller oss i PowerOffice. Det er derfor viktig at klientnøkkelen kopieres ut og håndteres forsvarlig, første gang man aktiverer en integrasjon og har dialogen for denne prosessen åpen i PowerOffice. Skulle dette bli avglemt eller klientnøkkelen mistet, kan integrasjonen fjernes og aktiveres på nytt. Da blir det generert en ny  unik klientnøkkel (som må formidles til integrasjonsparten og erstatte den gamle).

Illustrasjon av kommunikasjon mot PowerOffice: Bruker vs integrasjon

Nedenfor er en enkel skisse som illustrerer api kommunikasjonen mot PowerOffice sammenlignet med hvordan en vanlig bruker kommuniserer med PowerOffice via en nettleser på en pc.