Skip to main content

Oversikt

NVDB API Skriv eksponerer et sett med REST-baserte endepunkter for registrering og vedlikehold av data i Nasjonal vegdatabank (NVDB). Sammen med NVDB API Les utgjør disse endepunktene en komplett tjenesteportefølje for utviklere av fagsystemer som har behov for integrasjon med NVDB. APIene og NVDB eies og forvaltes av Statens vegvesen.

Registrering og vedlikehold av NVDB-data beskrives i et endringssett som behandles asynkront via endringssett-endepunktene. Et endringssett kan manipulere både vegobjekter og vegnett, men sistnevnte er forbeholdt spesifikke vegnettsklienter. I tillegg finnes støtte-endepunkter for:

  • Uthenting av låser, oppdrag og transaksjoner fra NVDB
  • Konvertering fra andre dataformater til endringssett
  • Innsyn i tildelte datarettigheter (autorisasjon)

Prinsipper​

  • Endepunktene som representerer ressurser/entiteter følger designprinsippene til Representational State Transfer (REST).
  • APIet er HTTP-basert. For å hente informasjon om en ressurs benyttes en GET-request. For å registrere eller oppdatere informasjon om en ressurs benyttes POST. Sistnevnte brukes også mot rene kommando-endepunkter. Responser vil ha en HTTP-statuskode som indikerer requestens korrekthet når det gjelder verb, URL, payload-format, tilgangskontroll m.m.
  • Alle endepunkter støtter payloads både i JSON og XML-format. En respons får samme format som requesten, med mindre noe annet er angitt med en Accept-header.
  • Alle URLer, URL-parametere og payloads, både i requester og responser, bruker norske domenebegreper.

Forutsetninger​

  • Alle requester skal ha følgende headere:
    • X-Client skal angi navnet på klienten som anroper APIet.
    • X-Request-ID skal angi en unik identifikator (UUID) for requesten. Denne gjenbrukes i eventuelle requester som NVDB API Skriv gjør til andre baksystemer.
  • Alle requester må inneholde et gyldig autentiseringstoken, i form av en Authorization-header.
  • Brukeren må ha relevante roller i Statens vegvesens LDAP-register.
  • Dersom brukeren skal registrere eller vedlikeholde data i NVDB, må hun være tildelt datarettigheter i NVDB API Skriv. Datarettigheter gir tilgang til spesifikke geografiske områder, vegtyper og vegobjekttyper.

Miljøer​

NVDB API Skriv er tilgjengelig i fire ulike miljøer hos Statens vegvesen:

MiljøFormålBasis-URLBasis-URL internt og eksternt
UTVUtviklinghttps://nvdbapiskriv.utv.atlas.vegvesen.no/https://nvdbapiskriv.utv.api.vegvesen.no/
STMSystemtestinghttps://nvdbapiskriv-stm.utv.atlas.vegvesen.no/https://nvdbapiskriv-stm.utv.api.vegvesen.no/
ATMAkseptansetestinghttps://nvdbapiskriv.test.atlas.vegvesen.no/https://nvdbapiskriv.test.api.vegvesen.no/
PRODProduksjonsdrifthttps://nvdbapiskriv.atlas.vegvesen.no/https://nvdbapiskriv.api.vegvesen.no/

De fire miljøene benytter hver sine instanser av NVDB. Alle NVDB instanser blir jevnlig oppdatert med dump fra PROD.

  • STM og ATM har åpne API-endepunkter mot internett slik at eksterne klienter kan teste mot miljøene. For tilgang til kontrollpanel eller autentisering utenfor Statens vegvesen sitt nettverk i STM eller ATM, kontakt nvdb@vegvesen.no for brannmuråpning.
  • Basis-URLer med .api. krever alltid et gyldig token. Det vil si at man må skaffe et token før man kaller endepunktene. Dette kan gjøres via ID-Bridge. Id-token aksepteres ikke.
  • Basis-URLer med .atlas. vil fases ut for eksterne klienter. Her aksepteres både id-token og access-token, men id-token vil fases ut. Utfasing kunngjøres i god tid før det skjer.

Support​

Forbedringer og feilrettinger i NVDB API Skriv rulles ut kontinuerlig. Endringer som er relevante for klienter og klientutviklere er beskrevet i en endringslogg.

Tekniske spørsmål omkring bruk av endepunktene sendes til nvdb-api@vegvesen.no.

Administrative henvendelser, f.eks. forespørsler omkring brukere, roller og datarettigheter, kan sendes til nvdb@vegvesen.no.