Julkinen API
Lue projektin dataa ohjelmallisesti. Todennus käyttötunnisteilla, perus-URL, muodot ja käytännöt.
Julkisen API:n avulla muut järjestelmät voivat lukea projektin dataa HTTP:n kautta, esimerkiksi syöttääkseen sitä THMI:n ulkopuolisiin koontinäyttöihin, raportteihin, laskutukseen tai analytiikkaan. Se tarjoaa saman datan, jonka näet Cloudissa (tagit, niiden arvot, historian ja sivut), tavallisena REST-API:na.
Todennus
Jokainen pyyntö todennetaan käyttötunnisteella. Luo tunniste, valitse mitä projekteja ja resursseja se saa lukea, ja lähetä se sitten bearer-tunnisteena:
Authorization: Bearer <your-token>Tunniste ulottuu vain niihin projekteihin ja resurssityyppeihin, jotka sille on myönnetty, joten voit antaa tarkasti rajattuja käyttöoikeuksia: täsmälleen sen datan, jota kukin järjestelmä tarvitsee, eikä enempää. API on vain luku -tyyppinen.
Perus-URL ja versiointi
API:a tarjotaan Cloud-palvelimesi polun /api/v1 alla, ja useimmat polut
koskevat yhtä projektia:
https://<your-cloud-host>/api/v1/{projectId}/...Polun v1 on API:n versio. Koko luettelo löytyy sivulta
Päätepisteet.
Muodot
- Vastaukset ovat oletuksena JSON-muodossa. Jotkin päätepisteet palauttavat myös CSV-muotoa (viennit ja historia) tai SVG-muotoa (sivut). Muoto on osa polkua silloin, kun se on valittavissa.
- Historian ja CSV-viennin päätepisteet käyttävät POST-metodia ja JSON-runkoa kyselyn välittämiseen (aikaväli, tagit, ryhmittely). Kaikki muu on GET-pyyntöjä. Molemmat ovat lukutoimintoja.
OpenAPI-määritys
API julkaisee oman OpenAPI-määrityksensä, joka on virallinen ja aina ajan tasalla oleva määrittely jokaisesta päätepisteestä, parametrista ja vastauksesta. Hae se JSON- tai YAML-muodossa:
https://<your-cloud-host>/api/openapi.json
https://<your-cloud-host>/api/openapi.yamlOsoita API-asiakasohjelmasi tai koodigeneraattorisi siihen sen sijaan, että kopioisit polkuja käsin.