Introduksjon
Velkommen til NVDB API Les V4 - den nyeste versjonen av NVDB API Les. Vi har utviklet V4 fra grunnen for å sikre økt stabilitet, skalerbarhet og fleksibilitet i endringer. En første versjon av APIet er nå tilgjengelig, og vi ser frem til tilbakemeldinger fra brukere som ønsker å migrere fra V3 til V4. Endringer i OpenAPI-spesifikasjonen er også implementert for å forbedre brukervennligheten og forståelsen av APIet.
Overgangsarkitektur
Som en del av prosjektet 'Digital Drivkraft', oppdaterer vi NVDB-kjernen i en stegvis prosess. NVDB API Les V4 er en integrert del av denne oppdateringen. For å lette overgangen, vil vi tilby en periode der både V3 og V4 er tilgjengelige. Dette gir brukerne fleksibilitet til å migrere i eget tempo og oss muligheten til å foreta nødvendige endringer uten å påvirke V3-brukere. I denne overgangsfasen vil V4 hente data fra V3, hvilket betyr at eventuelle feil i V3-data også vil gjenspeiles i V4 inntil videre.
Tilbakefall til V3
Under overgangsperioden tilbyr vi en tilbakefallsløsning til V3, i tilfeller der V4 mangler funksjonaliteten fra V3 eller ikke fungerer som forventet. Dette er en midlertidig løsning, og vi vil kommunisere når tilbakefallet fjernes. Denne løsningen sikrer kontinuerlig tilgang til V3 mens vi adresserer eventuelle problemer i V4.
Direkte til V4 uten tilbakefall
Hvis man vil benytte V4 uten tilbakefall til V3, for eksempel for å være sikker på at det er V4 man benytter, kan man spesifisere <tjeneste>/api/v4/ i tillegg, f.eks.:
https://nvdbapiles.atlas.vegvesen.no/vegobjekter/api/v4/vegobjekter/105
Merk at vegobjekter blir brukt to ganger her; første gang som navn på selve tjenesten, andre gang som del av endepunktet.
Migreringsguide
For å migrere fra NVDB API Les V3 til V4, endre APIets URL:
Fra:
https://nvdbapiles-v3.atlas.vegvesen.no
til:
https://nvdbapiles.atlas.vegvesen.no
NVDB API Les V4 tilbyr flere OpenAPI definisjoner.
Se valgmeny øverst til høyre i Swagger UI for å velge ønske definisjon. Følgende er tilgjengelig:
Forskjeller mellom V3 og V4
Data returnert fra V4 vil være identisk med V3 for å sikre bakoverkompatibilitet. Endringer i OpenAPI-spesifikasjonen er imidlertid gjennomført for å reflektere data nøyaktig og forbedre feilhåndteringen. Feil presenteres nå i henhold til RFC 7807 - Problem Details for HTTP APIs.
V4 introduserer nye parametere for å tilpasse datauttrekk, som inkluderer muligheten til å utelate sortering og totalt antall objekter, noe som kan akselerere datahenting. /statistikk endepunktet tillater nå også spesifikasjon av hvilke data som skal inkluderes i responsen.
Datatype er ikke i bruk i V4. Den er flagget i Datakatalogen (https://www.vegvesen.no/fag/teknologi/nasjonal-vegdatabank/datakatalogen/) at den vil utgå. I stedet for datatype skal man benytte egenskapstype, geometritype og stedfestingstype. Se denne siden for informasjon om egenskapstype i V4: https://nvdbapiles.atlas.vegvesen.no/webjars/swagger-ui/index.html?urls.primaryName=Datakatalog.
Ruteberegning i V4 med geometri oppfører seg slik det var tiltenkt. En geometris punkter styrer hvilke punkter en rute skal gå via, for å komme fra start til slutt. Geometrienes punkter blir projisert ned på på næremeste veglenke, og punktene bestemmer således hvordan ruten blir. (Gamle V3's oppførsel var slik i starten, den har utilsiktet fått en annen oppførel.)
Sideoppsett
I V4 er neste i sideoppsettet endret fra base64-kodet tekst til sidenummer, noe som forenkler forståelsen og implementeringen av paginering.
Fordeler med V4
- Økt stabilitet og utviklingsvennlighet
- Forbedret skalerbarhet
- Raskere datahenting
- Færre unødvendige data
- Raskere implementering av nye funksjoner
Begrensninger i V4
Begrensningene under overgangsperioden inkluderer:
- Data basert på V3
- Avanserte spørringer sendes til V3
V4 er uavhengig av V3s tilgjengelighet, takket være egne databaser for datahenting, noe som sikrer en stabil tjeneste.
Kontakt oss
For spørsmål, vennligst kontakt oss via e-post: nvdb-api@vegvesen.no