Automatické REST API a webhooky

03Jak to funguje

Jak to funguje krok za krokem.

1. 1

   Jak automatické API funguje

   API nemá kód pro jednotlivé entity. Jedna sada obecných cest obslouží každou entitu, kterou systém zná. Když správce přidá entitu, pole nebo vazbu, nebo se nasadí nový modul, API, validace i dokumentace existují okamžitě, jen pro danou firmu a v rozsahu oprávnění volajícího.

   Číst podrobněji

   Dostupnost entity rozhodují tři kontroly: příznak API u entity, zapnutý modul u firmy a oprávnění volajícího včetně politiky API klíče. Skrytá entita odpoví „nenalezeno“ a neprozradí ani svou existenci. Trezor hesel a preference přes API dostupné nejsou. Platí přihlášená relace v prohlížeči i token v hlavičce, se stejnými pravidly a auditem jako aplikace.

2. 2

   Co API umí

   Pro každou entitu jsou k dispozici výpis, detail, založení, úplná i částečná úprava a měkké smazání. Částečná úprava podporuje optimistické zamykání podle verze záznamu, takže dvě souběžné úpravy se nepřepíšou. K dispozici je popis entity (pole, vazby, akce), seznam id filtrované množiny (až 500) a export (až 1 000 záznamů).

   Číst podrobněji

   Hromadně lze založit až 100 záznamů, upravit až 500 a smazat až 100; kombinace založení, úprav a smazání proběhne v jedné transakci. Výpočty vrátí součty, průměry a další agregace nebo počty seskupené podle pole. API dále zvládá vazby (připojení, odpojení, synchronizaci), panely souvisejících záznamů, historii změn, audit, přílohy, akce nad záznamem i nad výběrem, převody záznamů s náhledem, nabídky pro výběr hodnot a globální vyhledávání.

   Řízené stavy mění jen akce.

3. 3

   Dotazy a filtry

   Filtry lze zapsat několika způsoby: hranatými závorkami, skupinami NEBO, vnořeným stromem, zkráceným zápisem typu amount>=10000, v JSON nebo uloženým filtrem. K dispozici je fulltextové hledání, řazení, stránkování (výchozí 20, nejvýše 200 záznamů na stránku), výběr polí a připojení souvisejících záznamů.

   Číst podrobněji

   Operátory pokrývají porovnání, obsahuje, začíná, rozsahy, prázdné hodnoty, výběry z více hodnot, datové předvolby jako tento měsíc nebo posledních 30 dní a vazbu na aktuálního uživatele či jeho tým. Neznámé pole, pole bez práva čtení nebo nepovolený operátor API odmítne, takže filtrem nelze vyzvídat data, ke kterým volající nemá přístup.

4. 4

   Dokumentace, přihlášení a limity

   Dokument OpenAPI 3.1.2 se generuje za běhu z metadat a z pohledu volajícího: entity a operace, které nesmí používat, v něm nejsou. Správce ho v administraci prohlíží v zobrazení Scalar. Validace a dokumentace používají stejné definice, takže se u pokrytých cest nerozcházejí.

   Číst podrobněji

   Token získáte přihlášením (s kódem druhého faktoru, je-li zapnutý) nebo podpisem SSH klíčem pro agenty v příkazové řádce. API klíče a MCP tokeny spravuje uživatel v profilu. Limit je 240 požadavků za minutu na firmu a uživatele; po 10 neúspěšných pokusech s tokenem za minutu se IP adresa omezí. Každé volání s tokenem se zapíše do přístupového logu.

5. 5

   Webhooky

   Odchozí webhook je akce ve workflow Automation. Spustí ji změna nebo smazání záznamu, plán, ruční spuštění nebo doménová událost. Odešle POST, PUT nebo PATCH s vlastními hlavičkami a šablonou těla. Cílová adresa prochází ochranou proti SSRF, přesměrování jsou vypnutá a časový limit je 30 sekund. Požadavek nenese podpis; neúspěšné volání se zaloguje a opakuje jen u atomického workflow nebo akce se zastavením při chybě.

   Číst podrobněji

   Příchozí webhook přijímá data na vlastní adrese chráněné sdíleným tajemstvím v hlavičce. Zpracuje je obsluha registrovaná modulem, například příjem leadů do CRM, nahrávky hovorů nebo push z Mattermostu. Každé volání se zaloguje i s výsledkem.