Introduktion
Hjørring Vandselskab stiller data fra fjernaflæste målere til rådighed via en REST API-adgang.
Adgangen gør det muligt at etablere en automatisk system-til-system integration, som kan hente data fra målerne til brug i egne IT-systemer – for eksempel til analyse, overvågning eller integration med eksisterende løsninger.
Hjørring Vandselskab kan ikke yde support til opsætning eller drift af dit modtagersystem, men vi hjælper gerne med spørgsmål vedrørende selve API-løsningen eller dokumentationen.
Begrænsninger
- API’et leverer udelukkende data fra Hjørring Vandselskabs fjernaflæste vandmålere – ejendomme beliggende i områder, som forsynes af et privat vandværk eller som har egen vandforsyning, er ikke omfattet
- Der kan hentes data for perioden fra og med d. 1. januar 2025 og frem. Det er ikke muligt at hente historiske data, som ligger før denne dato
Endpoints og base URL
Overordnet beskrivelse af løsning
API-løsningen fungerer efter følgende overordnede princip:
1. Autentificering
Kald POST /api/hub/Authenticate med brugernavn og adgangskode for et få et token.
Brugernavn og adgangskode er de samme som anvendes til kundeportalen og fremgår af øverste højre hjørne på din faktura.
2. Hent målerdata
Kald POST /api/hub/consumptionData med dit token for at hente forbrugsdata på målerniveau
I kaldet skal følgende oplysninger indgå:
- Forbrugsstedsnummer
- Målernummer
Det er også muligt at medsende filterkriterier for at afgrænse resultater. Du kan læse mere i dokumentationen på swagger:
https://hub.hjvand.dk/swagger
Oplysninger om forbrugsstedsnummer og målernummer findes i kundeportalen eller på din seneste årsopgørelse.
Årsopgørelsen sendes til ejeren af ejendommen. Hvis du ikke selv ejer ejendommen, skal du kontakte ejeren for at få de nødvendige oplysninger, da Hjørring Vandselskab ikke kan udlevere adgangsoplysninger til tredjepart.
Adgang for tredjepart
Det er på nuværende tidspunkt ikke muligt at oprette tredjepartsadgang til API‑løsningen.
Bemærk, at loginoplysninger til API‑adgang er de samme som til kundeportalen, og derfor giver adgang til begge platforme.
Hvilken data kan hentes
For hver forespurgt vandmåler kan følgende data hentes via API’et:
- Måleraflæsning (volumen)
- Forbrug i kubikmeter (beregnet forbrug siden senesteaflæsning)
- Aflæsningstidspunkt i UTC-tid
- Aflæsningstidspunkt i lokal tid
- Aflæsningstidspunkt i lokal tid afrundet til nærmeste hele time
- Eventuelle infokoder, der er aktive på det tidspunkt hvor aflæsningen modtages (lækage/brud/høj omgivelsestemperatur/lav omgivelsestemperatur)
Data hjemtages som udgangspunkt på timebasis, og vil som udgangspunkt være tilgængelige, når de er modtaget i systemet.
Der kan i enkelte tilfælde opstå forsinkelse i datahjemtagningen som følge af signalforhold, tekniske udfordringer eller anden driftspåvirkning.
Vilkår for brug af Hjørring Vandselskabs API‑service
Nedenstående vilkår gælder for brug af Hjørring Vandselskabs API‑løsning for adgang til vandmålerdata.
1. Omfang
API‑servicen giver adgang til vandmålerdata fra Hjørring Vandselskabs fjernaflæste vandmålere i henhold til disse vilkår.
Hjørring Vandselskab forbeholder sig retten til at ændre, begrænse eller lukke adgangen til servicen.
2. Ansvar for anvendelse
Brugeren er selv ansvarlig for:
- etablering, drift og vedligeholdelse af egne systemer, der anvender API‑servicen
- korrekt anvendelse af data
- overholdelse af gældende lovgivning, herunder databeskyttelseslovgivningen
Hjørring Vandselskab kan ikke holdes ansvarlig for direkte eller indirekte tab, der måtte opstå i forbindelse med brug af API‑servicen eller de data, der leveres via denne.
3. Ansvarlig brug af API‑servicen
Brugeren forpligter sig til at anvende API-servicen på en ansvarlig og lovlig måde og må ikke anvende servicen på en måde, der:
- medfører overbelastning, ustabil drift eller forringet tilgængelighed
- omgår eller forsøger at omgå tekniske eller sikkerhedsmæssige begrænsninger
- indebærer uberettiget videregivelse af adgangsoplysninger, tokens eller data
- anvender data til formål, som er i strid med gældende lovgivning
- anvender automatiserede kald i et omfang, der ikke står i rimeligt forhold til det tilsigtede formål
Hjørring Vandselskab forbeholder sig retten til uden varsel at:
- begrænse, suspendere eller lukke adgangen til API‑servicen ved konstateret eller mistænkt misbrug
- iværksætte tekniske foranstaltninger for at beskytte API servicen og øvrige brugere
4. Tredjepartsadgang og databehandlerforhold
Hvis brugeren giver tredjepart (fx rådgivere, systemleverandører eller driftsleverandører) adgang til API‑servicen eller de data, der hentes via API’et, er brugeren selv ansvarlig for:
- indgåelse af evnentuelle nødvendige databehandleraftaler
- at tredjeparten overholder gældende lovgivning
Hjørring Vandselskab indgår ikke databehandleraftaler med tredjepart på brugerens vegne.
Bemærk, at loginoplysninger til API‑adgang er de samme som til kundeportalen, og derfor giver adgang til begge platforme.
5. Datakvalitet og tilgængelighed
Hjørring Vandselskab tilstræber høj datakvalitet og stabil tilgængelighed, men giver ingen garanti for:
- fuldstændighed eller aktualitet af data
- uafbrudt adgang til API‑servicen
6. Support
Hjørring Vandselskab yder alene support vedrørende API‑servicen og den tilhørende dokumentation.
Support til brugerens egne systemer eller integrationer er ikke omfattet.
7. Ændringer
Hjørring Vandselskab forbeholder sig retten til løbende at ændre API‑servicen, dokumentationen og disse vilkår.