Test-API for NADAG innmelding

For at leverandører og andre interessenter skal kunne teste ut API-et, har vi det kjørende på https://test.ngu.no/api/nadag/innmelding/v1

OpenAPI-dokumentasjon er tilgjengelig på https://test.ngu.no/api/nadag/innmelding/openapi/v1, mens Swagger-UI for tjenester er tilgjengelig på https://test.ngu.no/api/openapi-ui/. "Explore"-tekstfeltet er feil innfylt i starten, skriv inn

  • /api/nadag/innmelding/openapi/v1 for innmelding-API-et

  • /api/nadag/innmelding/openapi/vedlegg for vedlegg-API-et

Oversikt over viktigste endepunkt-metoder

Validering av GU-data, uten autentisering, sti-prefiks er /api/nadag/innmelding/v1/validation.

  • POST /GeotekniskUnders, validerer en GU, som om en sender den inn som ny, men uten å lagre. Krever ikke autentisering, og kan dermed brukes av alle for å sjekke om en GU er gyldig før innsending.

Henting av autorisasjon-token, sti-prefiks er /api/auth/token

  • POST /{userUuid}, med JWT fra Maskinporten som innhold: Veksle inn JWT fra Maskinporten i JWT som kan brukes mot API. JTW-en som returneres lar en sende inn GU-data og vedlegg på vegne av denne brukeren. Bruker må tilhøre samme organisasjon som den som er registrert i Maskinporten, med mindre organisasjonen er registrert som IT-leverandør hos NGU.

Innmelding av data, sti-prefiks er /api/nadag/innmelding/v1. Authorization-headeren må inneholde '`Bearer ' etterfulgt av JWT-en fra `/api/auth/token-endepunktet.

  • POST /GeotekniskUnders: Opprett en ny grunnundersøkelse (GU), identifikasjon må være tom. Generert identifikasjon finnes i responsen, sammen med valideringsanmerkninger.

  • PUT /GeotekniskUnders/{lokalId}: Oppdater en tidligere innsendt GU, identifikasjon må være oppgitt (lokalId må stemme med sti-segment). Ny versjon opprettes, identifikasjon finnes i responsen, sammen med valideringsanmerkninger. Kallet tar inn parametre for å evt. overse listene med borehull, dokumenter, tolkede punkt og feltundersøkelser, slik at disse ikke trenger å sendes inn på nytt dersom de ikke skal endres.

  • POST /GeotekniskUnders/{guLokalId}/undersPkt: Legg til og/eller endre en liste med borehull-data for siste versjon av eksisterende GU. Ny versjon av GU-en opprettes, med borehull lagt til (de uten identifikasjon) evt. erstattet (de med identifikasjon). Responsen inneholder ny identifikasjon (versjon), sammen med valideringsanmerkninger.

  • PUT /GeotekniskUnders/{guLokalId}/undersPkt/{gbLokalId}: Endre data for et spesifikt borehull for siste versjon av eksisterende GU. Ny versjon av GU-en opprettes, med nye data for det angitte borehullet (identifikasjon må være oppgitt). Responsen inneholder ny identifikasjon (versjon), sammen med valideringsanmerkninger.

  • DELETE /GeotekniskUnders/{guLokalId}/undersPkt/{gbLokalId}: Borehull fjernes for siste versjon av eksisterende GU. Ny versjon av GU-en opprettes, hvor det angitte borehullet er fjernet. Responsen inneholder ny identifikasjon (versjon), sammen med valideringsanmerkninger.

Opplasting av vedlegg, sti-prefiks er /api/vedlegg

  • POST /: Last opp og opprett nytt vedlegg. UUID for vedlegget returneres i responsen.

  • POST /{uuid}: Last opp og opprett nytt vedlegg, med spesifikk UUID. Avvises dersom UUID allerede er i bruk.

  • PUT /{uuid}: Last opp og erstatt eksisterende vedlegg. Avvises dersom UUID ikke er i bruk, eller hvis vedlegget er knyttet til en annen organisasjon.

  • GET /{uuid}/download: Last ned vedlegg med angitt UUID.

Lesing av publiserte GU-data, uten autentisering, sti-prefiks er /api/nadag/innmelding/v1/open. Dette kan være mer praktisk enn å laste ned eller bruke OGC Features-API, men er selvsagt begrenset til data sendt inn via Nadag innmelding-API-et.

  • GET /GeotekniskUnders/{lokalId}, henter siste versjon av en GU med gitt lokalId, hvis denne er publisert (eller på vei til å bli det).

Autentisering

Test-API-et er satt opp med krav til autentisering via maskinporten og innveksling av autorisasjon-token i eget endepunkt på https://test.ngu.no/api/auth/token.

Validering

Validering av grunnundersøkelser og underliggende borehull, borehullsundersøkelser osv. er implementert.

Slipp-historikk

2026-3-13 API-et er oppdatert, fikset feil som gjorde at severity fikk object som type.

2026-2-10 API-et er utvidet/justert.

  • Når GU-data returneres, så er geometrien i originalt koordinatsystem. En kan oppgi en alternativ EPSG-kode i kallet, og da vil geometriene bli transformert til det koordinatsystemet.

  • En kan sende inn ny versjon av GU og oppgi at lista over borehull skal ignoreres, slik den kan være tom uten at gamle GB-er utelates fra den nye GU-versjonen. Det samme gjelder for dokumenter, tolkninger, feltundersøkelser.

  • Valideringsendepunktet kan brukes uten autentisering.

  • Nytt (eksperimentelt) endepunkt for å lese publiserte data på /api/nadag/innmelding/v1/open/GeotekniskUnders, som kan brukes uten autentisering. Kun siste versjon av en GU kan lese, og bare hvis denne versjonen er publisert (eller på vei til å bli det).

2026-1-13 Uendret API, men innstrammet sikkerhet ved bruk av Maskinporten.

  • En organisasjon må være godkjent av NGU for å kunne bruke API-et

  • Tilgangen gjelder bare innsending av data og vedlegg.

2025-12-19

  • Eget valideringsendepunkt på /api/nadag/innmelding/v1/validation/GeotekniskUnders, slik at en kan sjekke en GU uten at det lagre en ny versjon.

  • Bruk av statuskoden 422 Unprocessable Entity for alvorlige (FATAL) valideringsfeil, med detaljert informasjon i responsen.

…​

2025-06-06: Oppdatert versjon, med noen endringer og bedre rapportering av feilmeldinger.

  • GeotekniskBorehull i sti er erstattet med undersPkt

  • HTTP-status blir riktigere, f.eks. 400 Bad Request for ugyldig input

  • Mer informativ feilmelding i responsen

2025-05-27: Andre versjon av test-API-et er sluppet.

  • full autentisering

  • lagring av innmeldte GU-er

  • validering av GU-er og underliggende borehull, borehullsundersøkelser osv.

2025-02-04: Første versjon av test-API-et er sluppet.

  • ingen autentisering

  • ingen lagring av innmeldte GU-er

  • delvis validering av GU-er og underliggende borehull, borehullsundersøkelser osv.

    • sjekk av en del påkrevde felt

    • geometri må være innenfor fastlands-Norge

    • borehull må være innen grunnundersøkelsens område

    • borehullundersøkelser må være i nærheten av borehullet