Integrace RichPear Home
RichPear Home API
RichPear Home API zpřístupňuje REST rozhraní systému. Používá se pro integrace, skripty a vlastní nástroje, které potřebují číst nebo měnit stav.
- Doména
api- Kategorie
- Ostatní
- Komunikace
- podle nastavení integrace
- Nastavení
- ruční konfigurace
Co návod pokrývá
Návod popisuje praktické zapojení integrace RichPear Home API v RichPear Home, přípravu zařízení nebo účtu, kontrolu entit a zásady bezpečného použití v automatizacích.
Uživatelé obvykle otevírají systém na http://rphome.local:8123. Pokud tato adresa nefunguje, použijte http://IP-ADRESA:8123.
Hlavní témata
- Nastavení
- Entity
- Provozní kontrola
Příprava
Připravte dlouhodobý token nebo jiný podporovaný způsob ověření. Token vytvářejte jen pro konkrétní použití a uložte ho bezpečně.
Nastavení provádějte z účtu správce. Před přidáním si připravte názvy místností, očekávané entity a pravidla, kde se smí integrace používat.
Před prvním testem
Nejdřív ověřte dostupnost účtu, zařízení nebo služby mimo automatizace. Teprve potom zapojujte hodnoty do scén, notifikací nebo řízení domácnosti.
Nastavení v RichPear Home
API používejte přes lokální adresu systému nebo zabezpečenou interní adresu. Otestujte jednoduché čtení stavu a až potom zapisovací požadavky.
Po dokončení nastavení otevřete detail integrace v části Nastavení, Zařízení a služby. Zkontrolujte vytvořená zařízení, pojmenujte je podle skutečného umístění a vypněte entity, které nechcete používat.
Lokální adresa systému
Při práci v místní síti používejte http://rphome.local:8123. Pokud se lokální jméno nepřeloží, otevřete systém přes http://IP-ADRESA:8123.
Tokeny
Token považujte za heslo. Při úniku ho okamžitě zneplatněte a vytvořte nový s jasným účelem.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Čtení a zápis
Požadavky, které mění stav, testujte na neškodné entitě. Vlastní skripty musí počítat s chybovou odpovědí.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Síť
API nevystavujte veřejně bez bezpečné vrstvy a řízení přístupu. Pro lokální nástroje používejte http://rphome.local:8123 nebo http://IP-ADRESA:8123.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Kontrola po nasazení
Po nastavení integrace RichPear Home API sledujte alespoň jeden běžný provozní cyklus. U cloudových služeb počítejte se zpožděním, u lokálních zařízení ověřte chování po restartu routeru, zařízení i RichPear Home.
Do automatizací vkládejte jen hodnoty, které jste viděli v reálném provozu. Důležité akce doplňte podmínkou dostupnosti entity a rozumnou prodlevou, aby jednorázový výpadek nespustil chybnou reakci.
Před předáním běžným uživatelům ověřte názvy entit, práva uživatelů a chování při nedostupnosti služby. U zařízení, která něco fyzicky spínají nebo řídí, ponechte dostupné i ruční ovládání mimo automatizace.
Hotový provozní test
Integrace je připravená pro běžné použití, když se entity aktualizují, názvy odpovídají skutečným zařízením a automatizace mají ošetřený výpadek nebo nedostupný stav.