API-dokumentasjon

NVDB API Skriv

NVDB API Skriv er et asynkront REST-API for registrering og oppdatering av data i NVDB.

Systemet mottar beskrivelser av vegobjekter (endringssett) for registrering, oppdatering eller sletting i NVDB. En rekke validerings- og kontrolltrinn gjennomføres før data er godkjent og sendes til NVDB. Et endringssett under behandling omtales som en jobb. Flere av trinnene i en jobb krever oppslag i NVDB og vil derfor kunne ta en del tid, spesielt for klienter som registrerer mange vegobjekter samtidig. I tillegg vil selve skrivingen til NVDB også ta tid. Videre vil noen oppdateringer ikke kunne skje umiddelbart fordi data er låst av andre klienter (eller av en annen jobb i dette APIet). En konsekvens av dette er at jobber må eksekveres asynkront. Det vil si at klienten sender forespørsler for å definere og starte jobber, men siden svaret vil ta noe tid å utarbeide kan ikke et endelig svar leveres med en gang. Jobben blir i stedet behandlet i bakgrunnen, i en separat prosess som ikke blokkerer klienten.

Forutsetninger

For å kunne skrive data til NVDB gjennom API Skriv, trenger du:

Prinsipper

NVDB API Skriv setter strenge krav til mottatte data:

API V3

NVDB API Skriv V3 ble utviklet som en del av regionsreformprosjektet og gikk i produksjon høsten 2019. Se egen oversikt over endringer i V3.