Maskinporten
DiBK benytter Maskinporten for autentisering ved “maskin til maskin”-integrasjoner for Fellestjenester PLAN. DiBK er API-tilbyder og de som ønsker å benytte API-ene er konsumenter.
Hva er Maskinporten
Fra Digdir sin dokmentasjon:
”Maskinporten er en tjeneste som tilbyr en enkel modell for API-sikring basert på OAuth2 protokollen og bruk av JWT-bearer grants”.
Vi skiller mellom bruken av Maskinporten for API-tilbydere og API-konsumenter.
Hvordan ta i bruk Maskinporten som Api-konsument
For å benytte Maskinporten som API-konsument må konsumenten registrere en klientintegrasjon gjennom samarbeidsportalen til Digitaliseringsdirektoratet. I portalen velger man miljø og man setter opp hvilke scope som skal være tilgjengelige for integrasjonen. Dersom scopet ikke er tilgjengelig må du ta kontakt med DiBK slik at det kan eksponeres mot din virksomhet.
Konsumenten kan verifisere seg mot Maskinporten ved å bruke virksomhetssertifikat. For å kunne hente et aksesstoken må et gyldig virksomhetsertifikatet for korrekt miljø være installert på maskinen. Virksomhetssertifikat er virksomheten sin digitale ID og brukes til å signere forespørselen til Maskinporten. Virksomhetssertifikatet kan utstedes av Buypass eller Commfides som er godkjent av NKOM. Test- og produksjonsmiljø krever virksomhetssertifikat som er knyttet til korrekt miljø. Les mer om virksomhetssertifikat her.
Når klientintegrasjonen i samarbeidsportalen er opprettet kan man hente et token fra Maskinportens /token-endepunkt. Hvordan dette utføres er dokumentert her. Responsen fra Maskinporten-endepunktet vil inneholde tokenet som skal benyttes mot API-tilbyder som et “bearer-token” i “Authorization”-headeren på requesten.
Tjenester og scopes
Noen av Fellestjenester PLANs API-endepunkt krever forskjellige scope. For å gjennomføre en godkjent forespørsel til et endepunkt må et aksesstoken fra Maskinporten, inkludert korrekt scope, være med i Authorization-headeren til forespørselen. Her er en oversikt over de forskjellige endepunktene vi tilbyr med de forskjellige scopene som kreves for å motta resultatet.
Tjenestenavn | Endepunkt | Krever scope | Returnerer | Aktivt scope |
---|---|---|---|---|
Varsel om planoppstart til høringsmyndigheter | {miljø} + /dibk/uttalelseplanoppstart/submittal/planvarsel | dibk:plan/forsendelse.endre | staus og referranser | Nei |
|
|
|
|
|
Denne listen er ikke fullstendig utfylt da utviklingen ikke er fullført.