Publikt API

Läs ett projekts data programmatiskt — autentisering med åtkomstnycklar, bas-URL, format och konventioner.

Det publika API:et låter andra system läsa ett projekts data över HTTP — för att mata kontrollpaneler, rapporter, fakturering eller analys utanför THMI. Det exponerar samma data som du ser i Cloud (taggar, deras värden, historik och sidor), som ett vanligt REST-API.

Autentisering

Varje begäran autentiseras med en åtkomstnyckel. Skapa en nyckel, välj vilka projekt och resurser den får läsa och skicka den sedan som en bearer-token:

Authorization: Bearer <your-token>

En nyckel når endast de projekt och resurstyper den beviljats, så du kan dela ut snävt avgränsad åtkomst — exakt de data ett visst system behöver och inte mer. API:et är skrivskyddat.

Bas-URL och versionshantering

API:et tillhandahålls under /api/v1 på din Cloud-värd, och de flesta sökvägar är avgränsade till ett projekt:

https://<your-cloud-host>/api/v1/{projectId}/...

v1 i sökvägen är API-versionen. Se Slutpunkter för hela listan.

Format

• Svar är JSON som standard; vissa slutpunkter returnerar även CSV (för exporter och historik) eller SVG (för sidor) — formatet är en del av sökvägen där det gäller.
• Slutpunkter för historik och CSV-export använder POST med en JSON-kropp för att bära frågan (tidsintervall, taggar, gruppering); allt annat är GET. Båda är läsoperationer.

OpenAPI-specifikationen

API:et publicerar sin egen OpenAPI-specifikation — den auktoritativa, alltid uppdaterade definitionen av varje slutpunkt, parameter och svar. Hämta den som JSON eller YAML:

https://<your-cloud-host>/api/openapi.json
https://<your-cloud-host>/api/openapi.yaml

Rikta din API-klient eller kodgenerator mot den i stället för att kopiera sökvägar för hand.