Maskinporten er en tjeneste fra Digitaliseringsdirektoratet (DigDir) som tilbyr en enkel modell for API-sikring. Den underliggende teknologien er OAuth2-protokollen og bruk av JWT (JSON Web Token)-bearer grants.
API-tilgang i Fellestjenester Plan og Bygg vil etter hvert kreve at API-brukere blir autentisert via Maskinporten. Figuren under er en forenklet representasjon.
Dokumentasjon
...
DigDir har dokumentasjon for Maskinporten her: https://docs.digdir.no/docs/Maskinporten/
Den tekniske dokumentasjonene starter her: https://docs.digdir.no/docs/Maskinporten/
Teknisk sammendrag
Fellestjenester Plan og Bygg har mange API-er tilgjengelige på på tjenestene. Disse brukes til valideringer av data, oppsett av erklæringer, status på innsendinger, nedlasting av dokumenter, etc. DiBK er en tilbyder av disse API-ene.
Søknadssystemene eller sak-/arkiv systemene arkivsystemene som bruker APIene API-ene er konsumenter.
Autentisering for tilgang til FtPB APIene API-ene ble opprinnelig satt opp med “basic authentication” som er et brukernavn/passord som blir lagt med i headeren på kall mot APIeneAPI-ene.
Ved autentiseringen gjennom Maskinporten blir prosessen slik at konsument går til Maskinporten og ber om tilgang til et API, eller mer korrekt, de ber om tilgang til en ressursgruppe eller et “scope”. Maskinporten utsteder en nøkkel (“token“) som blir lagt ved kallet mot APIet API-et for å få tilgang til ressursen. Dette er illustrert i dokumentasjonen til Maskinporten under.
Mer informasjon om prosessen
...
Ta i bruk Maskinporten som konsument
Før en virksomhet registreres i Maskinporten må det bestilles virksomhetssertifikat for både test- og prod-miljøer. Informasjon om dette finnes her: https://docs.digdir.no/docs/Maskinporten/maskinporten_virksomhetssertifikat
Videre må virksomheten registreres i Samarbeidsportalen hos DigdirDigDir. Informasjon om dette er her: https://docs.digdir.no/docs/Maskinporten/maskinporten_guide_apikonsument
Skatteetaten har også dokumentert prosessen: https://skatteetaten.github.io/folkeregisteret-api-dokumentasjon/maskinporten/
...
DiBK administrerer tilgangen til API ved å konfigurerer tilgang til “scopes” for de forskjellige konsumentene. Konsumenter er identifisert ved organisasjonsnummer. Disse blir satt opp ved å kontakte oss på ServiceDeskservice desk.
Scopes
Følgende scopes er satt og for FtPB:
Scope | Beskrivelse |
---|---|
dibk:bygg/forsendelse.status | Status |
dibk:bygg/forsendelse.endre | Opprette Ansako erklæringer |
dibk:bygg/forsendelse.les | Nedlasting |
dibk:bygg/forsendelse.saksbehandling | Kommunedata fra arkivsystem |
dibk:plan/forsendelse.status | Status |
dibk:plan/forsendelse.endre | “write” |
dibk:plan/forsendelse.les | “read” |
...