API

ZiggyMeter vystavuje jednoduché a zabezpečné REST API pro konfiguraci, stav a integrace. Tato stránka shrnuje, jak se připojit a autentizovat před použitím koncových bodů.

Kompletní seznam koncových bodů naleznete v kapitole Koncové body.

Přenos

• Pouze HTTPS: všechny požadavky probíhají přes TLS na portu 443.
• Ve výchozím nastavení JSON: posílejte hlavičku Content-Type: application/json a očekávejte odpovědi ve formátu JSON, pokud není uvedeno jinak.

Autentizace

Formát hlavičky:

Authorization: Bearer <token>

Životnost tokenu:

• Tokeny jsou časově omezené. Odpověď na přihlášení vrací zbývající platnost v sekundách prostřednictvím pole expires_in_secs.
• Obnovte token před vypršením jeho platnosti nebo řešte chybu 401 Unauthorized opětovným přihlášením.

Příklad odpovědi na přihlášení:

{
    "token": "<token>",
    "expires_in_secs": 3600
}

Rychlý start

1. Získejte token

   curl -X POST \
   https://<host>/login \
   -H "Content-Type: application/json" \
   -d '{
       "username": "<username>",
       "password": "<password>"
   }'

2. Zavolejte jakékoli API s tokenem

   curl -X GET \
   https://<host>/api/v1/system/status \
   -H "Authorization: Bearer <token>" \
   -H "Accept: application/json"

   Pokud token chybí nebo je neplatný, API vrátí chybu autentizace.

3. Odhlášení

   curl -X POST \
   https://<host>/api/v1/system/logout \
   -H "Authorization: Bearer <token>"

Zavolání odhlášení okamžitě zneplatní aktuální token; další požadavky s tímto tokenem selžou s chybou autentizace. Pro pokračování získejte nový token opětovným přihlášením.

TIP

Pro testovací účely můžete zvážit přidání volby -k k příkazu curl, která umožňuje připojení k certifikátům podepsaným sebou samým nebo jinak nedůvěryhodným certifikátům.

Bezpečnější alternativy: Nainstalujte na server platný certifikát nebo nasměrujte curl na důvěryhodnou certifikační autoritu pomocí --cacert <ca.pem> (nebo použijte systémové úložiště důvěryhodných certifikátů).

Aktualizace

Při provádění aktualizace omezte rychlost nahrávání dat; v opačném případě zařízení nahlásí chybu. Níže uvedený příklad ukazuje omezení rychlosti pomocí volby --limit-rate nástroje curl.

curl -X POST  \
https://<host>/api/v1/system/ota \
-H "Authorization: Bearer <token>" \
--data-binary "@XXXX-YYYY-00320-20250324T195250-ZiggyMeter-1.2.320.ota" \
--limit-rate 1024