Przejdź do głównej zawartości

Uwierzytelnianie

SENS API uwierzytelnia zapytania kluczem API przesyłanym wyłącznie w nagłówku X-API-KEY — to nie jest token Bearer i nie jest to parametr zapytania. Klucz w URL-u (np. ?apiKey=...) wyciekałby do logów serwera, historii przeglądarki i nagłówka Referer, dlatego nie jest obsługiwany nigdzie — ani w publicznym API, ani w Swagger UI.

curl -s "https://api.getsens.energy/api/v1/tariffs" \
-H "X-API-KEY: sens_live_your_key_here"

Brak nagłówka lub nieprawidłowy klucz skutkuje odpowiedzią błędu — nie próbuj zgadywać poprawnego formatu przez enumerację, nieautoryzowane zapytania do chronionych ścieżek (w tym do Swagger UI) zwracają "stealth" 404, żeby nie ujawniać struktury API botom.

Zakres kluczy

Każdy klucz API jest przypisany do jednej organizacji (klienta) w panelu portal.getsens.energy i dziedziczy limity swojego planu. Klucze można generować i unieważniać samodzielnie z poziomu Integrations → API Keys.

Poziomy dostępu (plany)

SENS oferuje kilka poziomów planu, różniących się limitami zapytań i dostępnymi funkcjami:

PlanPrzeznaczenie
TRIALdarmowy okres próbny, do ewaluacji integracji
STARTERmniejsze integracje, pojedynczy produkt
GROWTHprodukcyjne wolumeny, webhooki
ENTERPRISEnajwyższe limity, SSE (server-sent events), dedykowany kontakt handlowy

Dokładne limity i ceny znajdziesz na getsens.energy — plan Enterprise wymaga bezpośredniego kontaktu, pozostałe plany są self-service.

Dobre praktyki

  • Nie osadzaj klucza API w kodzie frontendowym / aplikacji mobilnej — wywołuj SENS wyłącznie z backendu.
  • Jeśli budujesz klienta odpytującego cyklicznie (polling), skorzystaj z zapytań różnicowych since, żeby nie pobierać całego zbioru danych za każdym razem.