Gå til hovedinnhold

Versjonering

Se generell informasjon om hvordan vi versjonerer API-er her.

Bakoverkompabilitet​

Vi etterstreber å forbedre API-ene våres på en bakoverkompatibel måte der det er mulig.

For å gjøre det tydelig hva dere kan forvente fra API-et og hva vi forventer av dere som konsument, gis noen eksempler på hva vi anser som brekkende og ikke-brekkende endringer.

Bakoverkompatible endringer(ny MINOR eller PATCH):​

  • Legge til et nytt felt i responsen
  • Fjerne et valgfritt felt i responsen
  • Legge til et nytt endepunkt
  • Et felt i responsen går fra å være valgfritt til å være påkrevd
  • Legge til et valgfritt felt i requesten
  • Fikser av mindre bugs eller problemer i domenelogikk, for eksempel validering
  • Endre rekkefølgen (ikke hierarkiet) datafelter returneres i
  • Endringer som påvirker hvordan dataene kan oppføre seg uten at det berører selve datamodellen
  • Fjerne utilsiktet og udokumentert funksjonalitet, selv om dette kan være brekkende

Vi forventer at integrasjoner mot API-et er robuste nok til å tåle disse endringene. Se øvrig informasjon her for eksempler på brekkende endringer (major).

Hvor informerer vi om endringer​

Vi benytter flere kanaler for å informere om endringer: API-dokumentasjon, Lanseringer (RSS-feed), e-postlister*, teknisk informasjonsmøte. Hvor vi informerer varierer avhengig av endringen.

  • MAJOR: E-postlister*, teknisk informasjonsmøte, ny post på Lanseringer (RSS-feed)
  • MINOR: Ny post på Lanseringer (RSS-feed)
  • PATCH: Informerer ikke

API-dokumentasjonen vil alltid representere siste versjon av API-et. For endringer som er mindre enn MAJOR forventer vi at konsumenter selv holder seg oppdatert, enten ved å lese dokumentasjonen eller ved å subscribe til RSS-feeden.

* Alle virksomheter med aktiv avtale om eiendomsdata med Kartverket blir lagt til i denne listen og varslet i henhold til gjeldende avtale. Dersom du mistenker at du ikke mottar e-post som forventet, ta kontakt med matrikkelhjelp@kartverket.no