Veiledninger

Ebeco Open API

På denne siden får du informasjon om og tilgang til vår Open API. Vi har gjort denne tjenesten tilgjengelig for deg, slik at du kan utvikle din egen smartløsning.

Vilkår for bruk

Materialet som leveres gjennom Ebeco Open API, må ikke brukes til å distribuere ondsinnet kode eller på annen måte som kan skade Ebecos varemerke. Vi vil også at du oppgir Ebeco som kilde.

Komme i gang

Med Ebeco API kan du styre gulvvarmen i alle installasjoner som har termostaten EB-Therm 500 og WiFi-modulen EB-Connect.

Gjør følgende for å bruke vårt Open API:

  1. Installer WiFi-modulen EB-Connect i termostaten EB-Therm 500
  2. Velg nettverk, og oppgi passordet for nettverket i termostaten
  3. Last ned Ebeco Connect fra App Store eller Google Play
  4. Følg instruksjonene i appen for å opprette en konto
  5. Bruk dokumentasjonen nedenfor til å opprette din egen tjeneste eller app.

Tekniske spesifikasjoner

Ebecos API er en REST API som forventer og returnerer JSON.

Begrensninger

For å unngå misbruk av API-et, blir antall forespørsler begrenset på IP-adressenivå.
Du kan sende totalt 10 forespørsler i løpet av en periode på 10 sekunder og totalt 30 forespørsler i løpet av en periode på 60 sekunder. Hvis du overskrider antall forespørsler, vil API-et returnere “HTTP 429 For mange forespørsler” under resten av den ovennevnte perioden. Når perioden utløper, vil API-et begynne å svare igjen.

Merk! Antallet tillatte forespørsler kan endres når som helst av Ebeco uten forvarsel.

Autentisering

Autentisering til Ebecos API gjøres ved hjelp av et bærertoken som hentes fra /api/TokenAuth/Authenticate. Brukernavn og passord er de samme som brukes i Ebeco Connect-appen. I eksemplene nedenfor bruker vi Postman til forespørsler.

Parameteren Abp.TenantId bør alltid godkjennes i hodet og settes til 1.

Open API Headers

Brukernavn og passord sendes deretter som en POST-forespørsel til /api/TokenAuth/Authenticate.

Open API Post

Parameteren accessToken som returneres i svaret, brukes deretter til å autentisere til Ebeco API.

Eksempel:

Open API Post Access

Vi sender en GET-forespørsel til /api/services/app/Devices/GetUserDevices og autentiserer hodet med "bærer <accessToken>". En JSON-liste over den innloggede brukerens termostater returneres.

Hvis du ønsker en fullstendig referanse tiil metoder og parametre, kan du se vår Swagger-dokumentasjon på ebecoconnect.com/swagger