Vejledninger

Ebeco åbent API

På denne side finder du information om vores åbne API og adgang til det. Vi har åbnet tjenesten for dig, så du kan udvikle din egen intelligente løsning.

Brugerbetingelser

Det materiale, der leveres via Ebecos åbne API, må ikke bruges til distribution af ondsindet kode eller på måder, der kan skade Ebecos varemærke. Vi vil også bede dig om at angive Ebeco som kilde.

Sådan kommer du i gang

Med Ebecos API kan du styre gulvvarmen i alle installationer, der indeholder termostaten EB-Therm 500 kombineret med wi-fi-modulet EB-Connect.

Gør følgende for at bruge vores åbne API:

  1. Installer Wi-fi-modulet EB-Connect i termostaten EB-Therm 500
  2. Vælg det korrekte netværk, og indtast adgangskoden til netværket i termostaten
  3. Download "Ebeco Connect" fra App Store eller Google Play
  4. Opret en brugerkonto i henhold til anvisningerne i appen
  5. Opret din egen tjeneste eller app ved hjælp af nedenstående dokumentation

Tekniske specifikationer

Ebecos API er et REST-API, der forventer og returnerer JSON-data.

Begrænsninger

For at undgå misbrug af API'et er antallet af anmodninger begrænset på IP-adresseniveau.
Du kan sende i alt 10 anmodninger inden for en periode på 10 sekunder og i alt 30 anmodninger inden for en periode på 60 sekunder. Hvis antallet af anmodninger overskrides, returnerer API'et "HTTP 429 For mange anmodninger" i resten af den aktuelle periode. Når perioden slutter, begynder API'et at svare igen.

Obs! Antallet af tilladte anmodninger kan til enhver tid ændres af Ebeco uden forudgående varsel.

Autentificering

Autentificering til Ebecos API sker ved hjælp af et bearer-token, der hentes fra /api/TokenAuth/Authenticate. Brugernavnet og adgangskoden er de samme som i appen Ebeco Connect. I eksemplerne nedenfor bruger vi Postman til at sende anmodninger.

Parameteren Abp.TenantId skal altid sendes med i headeren med værdien 1.

Open API Headers

Brugernavnet og adgangskoden sendes derefter som en POST-anmodning til /api/TokenAuth/Authenticate.

Open API Post

Parameteren AccessToken, der returneres i svaret, bruges derefter til autentificering mod Ebeco-API'et.

Eksempel:

Open API Post Access

Vi sender en GET-anmodning til /api/services/app/Devices/GetUserDevices og autentificerer overskriften med "Bearer <accessToken>". Svaret indeholder en JSON-liste med den indloggede brugers termostater.

En komplet reference over alle metoder og parametre kan findes i vores Swagger-dokumentation på  ebecoconnect.com/swagger