API¶
API chmury umożliwia integrację danych z platformy OneMeter z zewnętrznymi systemami. Użytkownik API (lub inaczej: Klient API) może na przykład:
- pobrać listy urządzeń,
- pobrać szczegółów danego urządzenia,
- pobrać odczytów z wybranym okresem agregacji, zakresem dat i danych,
- wyeksportować danych do pliku XLSX lub CSV.
Jak zacząć?¶
Uzyskaj dostęp do API i zapoznaj się z dokumentacją OneMeter Cloud API (dostępną również na górnej belce po zalogowaniu w chmurze). Potem możesz kierować już zapytania do serwera. Używaj ich z rozwagą aby nie przeciążać nadmiernie serwera bez potrzeby.
Przykład zapytania programem curl poniżej.
curl -H "Authorization: TU_WKLEJ_TWÓJ_KLUCZ_API" "https://cloud.onemeter.com/api/devices"
Uzyskaj dostęp do API¶
Wystarczy utworzyć klucz API. Rozwiń poniższą instrukcję i podążaj za jej krokami.
Dostęp do API w 3 krokach
Kliknij przycisk Uzyskaj dostęp do API.
Skopiuj klucz API i zachowaj w bezpiecznym miejscu.
Klucza API użyjesz podczas kierowania zapytań do serwera. W przyszłości możesz go zmienić lub zablokować dostęp do API właśnie w tym miejscu.
Każdy użytkownik ma osobny dostęp do API
Jeśli chcesz podzielić danymi z innym użytkownikiem, udostępnij mu swoje urządzenie zamiast swojego konta i klucza API. Możesz to zrobić w ustawieniach uprawnień urządzenia w aplikacji mobilnej i chmurze.
Zablokuj dostęp do API¶
Aby zablokować dostęp do API, przejdź do opcji Ustawienia użytkownika w chmurze (widocznej po rozwinięciu menu w prawym górnym rogu) i kliknij przycisk Zablokuj dostęp do API.
Integracje¶
W dokumentacji API zamieściliśmy przykłady integracji z popularnymi systemami inteligentnego domu takimi jak Home Assistant, OpenHAB i Domoticz.
Zachęcamy do zapoznania z przykładami integracji po przetrenowaniu kilku zwykłych zapytań API
Do poprawnej konfiguracji integracji z zewnętrznymi systemami wymagane jest zrozumienie zawartości zwracanej przez nasze API aby odpowiednio dopasować ją do dostępnych w chmurze danych i preferencji Użytkownika.