API-ene som blir tilbudt mot eByggesakssystemene vil være av typen REST. De vil levere data inn til Fellestjenester PLAN og BYGG (FtPB). Når data blir mottatt, settes det opp en mekanisme for varsle leverandørene om at nye data er tilgjengelige. Vi oppfordrer til at kun ny informasjon eller endret informasjon sendes med i API-ene, slik at FtPB og søknadssystemene ikke blir belastet med duplisert informasjon.

Open

Miljøer

Test og dokumentasjon av API-ene er også tilgjengelig på Swagger: https://saksbehandlingsapi.ft-test.dibk.no/swagger/index.html

Du finner mer informasjon og eksempler på kall under hvert API.

Saksbehandlingssystemene bestemmer trigger

Milepæler og andre endringer kan oppdateres manuelt eller automatisk (eller som en kombinasjon av dette), og saksbehandlingssystemene må selv avgjøre hvordan dette skal trigges i sine systemer. Et forslag er at saksbehandler i arbeidsflaten sender oppdateringer i prosessen. Dersom hen velger å utsette oppdateringen, vil den samles opp og sendes før saksbehandler kan gå videre til neste saksbehandlingsfase/-prosess. Vi anbefaler at saksbehandler gjør en kontroll før oppdateringen sendes.

Sekvensielle kall

De ulike API-ene må sende oppdateringene i sekvenser. Det vil si at eByggesakssystemet må returnere informasjon i flere kall dersom saksbehandler gjør flere oppdateringer. Et eksempel er dersom en sak splittes i to fordi det er to ulike tiltak som skal behandles separat, og at den nye saken får nytt kontaktpunkt. Her vil både API for endret saksnummer og API for saksoppdatering sende informasjon.

Detaljer rundt bruk og oppdatering av API-ene og validering av feltene, vil komme.

Notifikasjoner

Vi legger opp til å ha en mekanisme for å varsle søknadssystem om at nye data er tilgjengelig på en sak, slik at det ikke er nødvendig med poll på Status-API kontinuerlig.

Notifikasjon blir satt opp gjennom tjenesten Event Grid på Azure. Det krever at søknadssystemene setter opp en eller flere callback URL-er der de kan bli varslet om oppdateringer. Event Grid har enkle mekanismer for retry av meldinger. Oppsett og autentisering for søknadssystemer settes opp gjennom Service Desk eller eget grensesnitt i FtPBs adminportal.

Basic authentication

API-ene skal beskyttes med BA, men vi gå over til Maskinporten på sikt.

Mer informasjon og eksempler kommer.