Deling av offentlige data via API innen akvakultur-området
Som offentlig organ ønsker vi å legge til rette for åpenhet i forvaltningen, og tilgjengeliggjøre enkelte datasett via API. Disse datasettene er offentlige, og inneholder ikke sensitiv informasjon.
Vi har samlet alle datasettene som skal være offentlig tilgjengelige i samme API, for å gjøre det enkelt å finne og bruke dem.
Hvordan bruke API-et
De ulike tjenestene er delt i to
- REST-endepunkter uten noe autentisering hvor man kan hente data ved behov (pull)
- Abonnementstjeneste hvor vi fortløpende dytter data til abonnenter når de kommer inn til oss (push). Denne tjenesten krever autentisering via maskinporten
Har du en løsning som konsumerer og oppdaterer data løpende anbefales det at du bruker abonnementstjenesten. OpenAPI-dokumentasjonen inneholder mer detaljer om de ulike endepunktene, og informasjon om tilhørende JSON-skjemaer
Oppsett og bruk av abonnement
Autentisering
Klientkall for å opprette et abonnement autentiseres med et bearer access-token som genereres av Maskinporten, se beskrivelser på Digdir Docs (digdir.no). Alle som oppretter en integrasjon i Maskinporten har tilgang til abonnementer i utviklings- og produksjonsmiljøet.
Når du oppretter en integrasjon (OAuth2-klient) i Maskinporten, bruker du følgende scope for å få tilgang: mattilsynet:akvakultur.offentlig.data
Opprett abonnement
For å sette opp et abonnement, kaller du /abonnement-endepunktet for datasettet du ønsker å få data fra. Husk å bruke maskinporten til autentisering, se avsnittet over. Dere må ha satt opp et egendefinert endepunkt i deres tjeneste som er beskyttet med en egendefinert api-nøkkel via Authorization header. Dere sender så med API-nøkkelen og URL-en til oss når dere oppretter abonnement. Det er mulig å oppdatere API-nøkkel og beholde samme abonnement dersom man ønsker å rullere nøkler. Vi forventer å kunne kalle endepunktet deres på denne måten:
curl --location 'https://eksempel.no/egendefinert-url' --header 'Content-Type: application/json' --header 'Authorization: api-key-value' --data '{...}'
Flyt ved opprettelse av abonnement
Etter opprettelse, flyt for å motta data på abonnement
