Přeskočit na hlavní obsah

Changes API a WebHooks

Changes API - Postup zavedení WebHooks

Autor: Petr Pech

Changes API umožňuje číst jen to, co se od posledního dotazu změnilo — místo opakovaného stahování celých evidencí. Web Hooks na tytéž změny umí upozornit voláním na Vaši adresu.


Aktivace Changes API

Stav zjistíte dotazem, zapnutí i vypnutí je metoda PUT:

Adresa

Metoda

Význam

/c/{firma}/changes/status.xml

GET

Vrátí Changelog is enabled. nebo Changelog is disabled.

/c/{firma}/changes/enable

PUT

Zapne sledování změn.

/c/{firma}/changes/disable

PUT

Vypne sledování změn.

/c/{firma}/changes/control

GET

Stejné ovládání ve webovém rozhraní.

⚠️ Zapnutí i vypnutí zasahuje do databázových triggerů, proto v licenci nesmí být přihlášení uživatelé — jinak akce skončí chybou. Podrobněji ji popisuje článek Nelze zapnout Changes API.


Čtení změn

GET /c/{firma}/changes.xml

Odpověď nese v kořenovém elementu globalVersion — číslo, od kterého se ptáte příště. U každého záznamu je pak vidět, co se s ním stalo:

<winstrom globalVersion="143902">
<cenik in-version="1" operation="update" timestamp="2019-01-01 00:00:00.0">
<id>170</id>
<id>code:DEVET</id>
</cenik>
</winstrom>


Web Hooks

Registrace i výpis háčků se dělají na adrese /c/{firma}/hooks:

PUT /c/{firma}/hooks.xml?url=http://muj.server.cz/hook.php&format=XML

GET /c/{firma}/hooks.xml

ℹ️ Web Hooks musí být povolené na straně serveru. Pokud povolené nejsou, odpoví každý dotaz na /hooks chybou 400 s hláškou Hooks are not enabled in flexibee-server.xml — v cloudu o zapnutí požádejte podporu, u vlastní instalace jde o nastavení serveru.


Související

Dostali jste odpověď na svou otázku?