Oppaat

Ebeco Open API

Tältä sivulta löydät tietoa ja pääsyn avoimeen Open API:in. Tämä palvelu tarjotaan käyttöön oman älykkään ratkaisun kehittämiseen.

Käyttöehdot

Ebeco Open API:n kautta toimitettua materiaalia ei saa käyttää haitallisen koodin levittämiseen tai millään tavalla, joka voi vahingoittaa Ebecon tavaramerkkiä. Haluamme myös, että Ebeco esitetään lähteenä.

Aloittaminen

Ebeco API: n avulla voit ohjata lattialämmitystä kaikissa asennuksissa, joissa EB-Therm 500 -termostaatti on käytössä EB-Connect WiFi-moduulin kanssa.

Voit käyttää Open APIa seuraavasti:

  1. Asenna EB-Connect WiFi -moduuli EB-Therm 500 -termostaattiin
  2. Valitse verkko ja kirjoita verkon salasana termostaattiin
  3. Lataa Ebeco Connect App Storesta tai Google Playsta
  4. Luo tili noudattamalla sovelluksen ohjeita
  5. Luo oma palvelu tai sovellus alla olevien ohjeiden avulla.

Tekniset tiedot

Ebecon API on REST-sovellusliittymä, joka odottaa ja palauttaa JSON-tiedostoja.

Rajoitukset

APIn väärinkäytön välttämiseksi pyyntöjen määrä rajoitetaan IP-osoitetasolla.
Käyttäjällä on oikeus lähettää yhteensä 10 pyyntöä 10 sekunnin aikana ja yhteensä 30 pyyntöä 60 sekunnin kuluessa. Jos ylität pyyntöjen määrän, API palauttaa viestin ”HTTP 429 Too many requests” loppuajan aikana. Kauden päättymisen jälkeen API alkaa vastata uudelleen.

Huom! Ebeco voi muuttaa sallittujen pyyntöjen määrää milloin tahansa ilman ennakkoilmoitusta.

Todennus

Todennus Ebecon APIssa tapahtuu Bearer Token -tunnisteella, joka saadaan kohdasta /api/TokenAuth/Authenticate. Käyttäjätunnukset ja salasanat ovat samat kuin Ebeco Connect -sovelluksessa. Alla olevissa esimerkeissä käytämme Postmania pyyntöihin.

Abp.TenantId-parametri tulisi aina välittää Header-osiossa ja asettaa arvoon 1.

Open API Headers

Käyttäjätunnus ja salasana lähetetään sitten POST-pyyntönä kohteeseen /api/TokenAuth/Authenticate.

Open API Post

Vastauksessa palautettua accessToken-parametria käytetään sitten todentamaan Ebeco API.

Esimerkki:

Open API Post Access

Lähetämme GET-pyynnön kohteeseen /api/services/app/Devices/GetUserDevices ja todennamme otsikon käyttämällä ”Bearer<accessToken>”. Vastauksena tulee JSON-luettelo kirjautuneista käyttäjän termostaateista.

Täydellinen viite menetelmistä ja parametreista on Swagger-dokumentaatiossa, joka sijaitsee osoitteessa ebecoconnect.com/swagger