Yr.no

API for mottak av badetemperaturer

Dersom du ønsker å hente badetemperaturer fra oss, kan du lese hvordan på siden for API for badetemperaturer

For å sende inn badetemperaturer til Yr, må du bruke stedsnavn som er søkbare på Yr.no. 

Dersom det er badeplasser med lokale, godt kjente navn, som ikke finnes som stedsnavn på Yr, kan vi legge de til. Send oss da en e-post med navn på badeplassen og koordinatene til support@yr.no. Merk eposten med "Forespørsel om å legge til ny badeplass". Les mer om stedsnavn nederst på denne siden

API-nøkkel

For å få API-nøkkel, send en epost til oss med "Forespørsel om API-nøkkel til badetemperaturer", med navn og epost til kontaktperson, til support@yr.no. Spesifiser om du ønsker nøkkel for å hente ut eller sende inn badetemperaturer, eventuelt begge deler.

Vilkår

Ved å sende inn badetemperaturer gir du NRK stedsuavhengig, ubegrenset og evigvarende rett til tilgjengeliggjøring for allmenheten og videreformidling av badetemperaturene på enhver kjent og ukjent teknisk plattform og uavhengig av distribusjonsmåte.

Datastruktur

Data sendes med request body (payload) i JSON format.
Strukturen er som i eksempelet under:

[
  {
    "name": "Myrdammen",
    "lat": 59.86241,
    "lon": 11.07866,
    "heatedWater": false,
    "temperature": 19.0,
    "time": "2021-06-03T10:17:54+02:00"
  },
  {
    "name": "Nebbursvollen friluftsbad",
    "lat": 59.96759,
    "lon": 11.02616,
    "heatedWater": true,
    "temperature": 24.0,
    "time": "2021-06-03T09:59:09+02:00"
  }
]

Vi tar i mot en liste med en eller flere registreringer.

Om parameterne

"name": string -> påkrevd - Navnet på badeplassen. Les mer om stedsnavn nederst på denne siden.
"lat": double -> påkrevd - Breddgrad i desimalgrader
"lon": double -> påkrevd - Lengdegrad i desimalgrader
"heatedWater": bool -> valgfri - Angi om registreringen er fra et kunstig oppvarmet vann, som f.eks. et basseng. Standard er false.
"temperature" : double -> påkrevd - Den registrerte temperaturen
"time": datetimeoffset -> påkrevd - Dato og tid for registreringen med offset (tidsforsyvning i forhold til UTC, som i Norge er +02:00 ved sommertid, og +01:00 ved normaltid). Dersom offset utelates, tolker vi det til UTC (+00:00)

Payload'en sendes med POST til https://badetemperaturer.yr.no/api/registrere

Requesten må inneholde en header, "apikey", med enn unik nøkkel som vi utsteder.

Respons

Responsen vil normalt returnere http 200 Ok:

{
  "message": "Saved 2 entries"
}

Manglende eller feil api-nøkkel, http 401 Unauthorized:

{
  "message": "Invalid credentials"
}
{
  "message": "Missing credentials"
}

Tom payload eller feil i json-data, http 400 Bad request:

{
"message": "Empty payload"
}

Stedsnavn

Navnet på badeplassen må være et stedsnavn som finnes i stedssøket på Yr. Dvs i hovedsak steder fra Sentralt stedsnavnregister (SSR) hos Kartverket. Navnet må også finnes i nærheten av posisjonen som blir oppgitt. Dersom du opplever at registreringen din får et annet navn enn det du har sendt, kan det være at punktet for stedsnavnet på Yr og koordinatene du oppgir for din sensor, er for langt unna hverandre.

Vi henter de 30 nærmeste stedsnavnene til koordinatene som oppgis, og matcher dette med "name". Får vi ikke match, vil vi bruke stednavnet som ligger nærmest oppgitte koordinater. Dette er for at vi skal kunne lenke til værvarselet for stedet i visningen på Yr.

Kartverkets tjeneste Norgeskart kan være et nyttig verktøy for å se posisjonen til et stedsnavn. Alle stedsnavn du finner i denne tjenesten finnes også på Yr.

Relaterte artikler