Guider

Ebeco öppet API

På denna sida hittar du information om vårt öppna API och åtkomsten till det. Vi har öppnat tjänsten för dig så att du kan utveckla din egen smarta lösning.

Användningsvillkor

Materialet som tillhandahålls via Ebecos öppna API får inte användas för distribution av skadlig kod eller på sätt som kan skada Ebecos varumärke. Vi vill också att du uppger Ebeco som källa.

Kom igång

Med Ebecos API kan du styra golvvärmen i alla installationer som innehåller termostaten EB-Therm 500 tillsammans med WiFi-modulen EB-Connect.

Gör följande för att använda vårt öppna API:

  1. Installera WiFi-modulen EB-Connect i termostaten EB-Therm 500
  2. Välj rätt nätverk och skriv in nätverkets lösenord i termostaten
  3. Hämta ”Ebeco Connect” från App Store eller Google Play
  4. Skapa ett användarkonto enligt anvisningarna i appen
  5. Skapa din egen tjänst eller app med hjälp av nedanstående dokumentation.

Tekniska specifikationer

Ebecos API är ett REST-API som förväntar sig och returnerar JSON-data.

Begränsningar

För att undvika missbruk av API:et begränsas antalet förfrågningar på IP-adressnivå.
Du får skicka sammanlagt totalt 10 förfrågningar inom en period på 10 sekunder och totalt 30 förfrågningar inom en period på 60 sekunder. Om antalet förfrågningar överskrids returnerar API:et ”HTTP 429 För många förfrågningar” under återstoden av den aktuella perioden. När perioden är slut börjar API:et att svara igen.

Obs! Antalet tillåtna förfrågningar kan när som helst ändras av Ebeco utan föregående meddelande.

Autentisering

Autentisering till Ebecos API sker med ett bearer-token som hämtas från /api/TokenAuth/Authenticate. Användarnamnet och lösenordet är samma som i appen Ebeco Connect. I exemplen nedan använder vi Postman för att sända förfrågningar.

Parametern Abp.TenantId ska alltid skickas med i headern med värdet 1.

Open API Headers

Användarnamnet och lösenordet skickas sedan som en POST-begäran till /api/TokenAuth/Authenticate.

Open API Post

Parametern accessToken som returneras i svaret används sedan för autentisering mot Ebeco-API:et.

Exempel:

Open API Post Access

Vi skickar en GET-begäran till /api/services/app/Devices/GetUserDevices och autentiserar rubriken med ”Bearer <accessToken>”. Svaret innehåller en JSON-lista med den inloggade användarens termostater.

En fullständig referens över alla metoder och parametrar finns i vår Swagger-dokumentation på  ebecoconnect.com/swagger