Preskoči na glavno vsebino

Changes API a WebHooks

Changes API – Postup zavedenia WebHooks

Avtor: Petr Pech

Changes API umožňuje čítať len to, čo sa od posledného dotazu zmenilo — namiesto opakovaného sťahovania celých evidencií. Web Hooks o tých istých zmenách vie upozorniť volaním na Vašu adresu.


Aktivácia Changes API

Stav zistíte dotazom, zapnutie aj vypnutie je metóda PUT:

Adresa

Metóda

Význam

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

GET

Vráti Changelog is enabled. alebo Changelog is disabled.

/c/{firma}/changes/enable

PUT

Zapne sledovanie zmien.

/c/{firma}/changes/disable

PUT

Vypne sledovanie zmien.

/c/{firma}/changes/control

GET

Rovnaké ovládanie vo webovom rozhraní.

⚠️ Zapnutie aj vypnutie zasahuje do databázových triggerov, preto v licencii nesmú byť prihlásení používatelia — inak akcia skončí chybou. Podrobnejšie ju popisuje článok Nelze zapnout Changes API.


Čítanie zmien

GET /c/{firma}/changes.xml

Odpoveď nesie v koreňovom elemente globalVersion — číslo, od ktorého sa pýtate nabudúce. Pri každom zázname je potom vidieť, čo sa 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

Registrácia aj výpis háčikov sa robia 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 musia byť povolené na strane servera. Ak povolené nie sú, na každý dotaz na /hooks odpovie chyba 400 s hláškou Hooks are not enabled in flexibee-server.xml — v cloude o zapnutie požiadajte podporu, pri vlastnej inštalácii ide o nastavenie servera.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?