Publiczne API
Odczytuj dane projektu programowo — uwierzytelnianie tokenami dostępu, bazowy URL, formaty i konwencje.
Publiczne API pozwala innym systemom odczytywać dane projektu przez HTTP — na potrzeby dashboardów, raportów, rozliczeń lub analiz poza THMI. Udostępnia te same dane, które widzisz w Cloud (tagi, ich wartości, historię i strony), jako zwykłe REST API.
Uwierzytelnianie
Każde żądanie jest uwierzytelniane tokenem dostępu. Utwórz token, wybierz, które projekty i zasoby może odczytywać, a następnie wysyłaj go jako token bearer:
Authorization: Bearer <your-token>Token sięga tylko do projektów i typów zasobów, do których otrzymał dostęp, więc możesz przydzielać wąsko ograniczony dostęp — dokładnie do tych danych, których potrzebuje dany system, i do niczego więcej. API służy tylko do odczytu.
Bazowy URL i wersjonowanie
API jest udostępniane pod /api/v1 na twoim hoście Cloud, a większość ścieżek
dotyczy konkretnego projektu:
https://<your-cloud-host>/api/v1/{projectId}/...v1 w ścieżce to wersja API. Pełną listę znajdziesz w sekcji
Punkty końcowe.
Formaty
- Odpowiedzi są domyślnie w formacie JSON; niektóre punkty końcowe zwracają też CSV (dla eksportów i historii) lub SVG (dla stron) — tam, gdzie ma to zastosowanie, format jest częścią ścieżki.
- Punkty końcowe historii i eksportu CSV używają POST z treścią JSON, która przenosi zapytanie (zakres czasu, tagi, grupowanie); wszystkie pozostałe używają GET. Oba rodzaje to operacje odczytu.
Specyfikacja OpenAPI
API publikuje własną specyfikację OpenAPI — wiarygodną, zawsze aktualną definicję każdego punktu końcowego, parametru i odpowiedzi. Pobierz ją jako JSON lub YAML:
https://<your-cloud-host>/api/openapi.json
https://<your-cloud-host>/api/openapi.yamlWskaż ją swojemu klientowi API lub generatorowi kodu, zamiast ręcznie kopiować ścieżki.