Velkommen til RegObs WebAPI

Innhold

• 1 Introduksjon
  • 1.1 Om data i regObs
• 2 Versjoner
  • 2.1 Prod versjoner
  • 2.2 Demo versjon
  • 2.3 Test versjon
• 3 Hvordan bruke API'et
  • 3.1 Format
  • 3.2 Registrering av en hendelse
  • 3.3 Registreringsobjektet

1. Introduksjon

Api'et er i hovedsak tenkt å tilgjengeliggjøre registrering av data til regObs.

For å registrere data via api'et trenger du å få tilgang via NVE sitt regobs team. Ta kontakt på epost raek@nve.no.

1.1 Om data i regObs

Data på regObs produseres av brukerne av regObs og foreligger ”som den er”. Den kan inneholde feil og utelatelser. NVE gir ingen garantier for informasjonens aktualitet og tar ikke ansvar for at data kan gi feil eller villedende informasjon. Antall stjerner (1-5) beskriver kompetansenivået til den som leverer observasjoner. Uten stjerner er kompetansen ukjent eller lav.

2. Versjoner

Det vil komme nye versjoner av APIet, så det er et versjonsnummer i lenken. Vi lar gamle versjoner leve en stund, men de blir fjernet uten forvarsel.

Latest er alltid siste versjon av API'et, den blir oppdatert uten forvarsel. Hvis du vil være trygg på at det ikke er "breaking changes" i API'et du bruker så bruk en spesifikk verjson.

2.1 Prod versjoner:

• Versjon Latest: https://api.nve.no/hydrology/regobs/webapi_latest/
  • Alltid siste versjon av API'et. Blir oppdatert uten forvarsel.
• Versjon 3.1.0.*: https://api.nve.no/hydrology/regobs/webapi_v3.1.0/
  • Swagger er implementert for bedre dokumentasjon av APIet
  • mer info kommer...
• Versjon 2.0.0.*: https://api.nve.no/hydrology/regobs/webapi_v2.0.0/
  • Ny observasjonstype: AvalancheActivityObs2, bruk den i stedenfor AvalancheActivityObs
• Versjon 1.2.*: https://api.nve.no/hydrology/regobs/webapi/

Her er vår presentasjon av dataene: http://www.regobs.no/

2.2 Demo versjon:

Versjonen blir oppdatert uten forvarsel.

• https://api.nve.no/hydrology/demo/regobs/webapi

2.3 Test versjon:

Versjonen blir oppdatert uten forvarsel.

• http://tst-h-web03.nve.no/regobswebapi/

3 Hvordan bruke API'et

3.1 Format

API'et leverer data som JSON

3.2 Registrering av en hendelse

Les mer her.

3.3 Registreringsobjektet

Les mer her.

Kontakt

Spørsmål kan stilles til Anders Wartiainen.