Automatické REST API a webhooky

03Ako to funguje

Ako to funguje krok za krokom.

1. 1

   Ako automatické API funguje

   API nemá kód pre jednotlivé entity. Jedna sada všeobecných ciest obslúži každú entitu, ktorú systém pozná. Keď správca pridá entitu, pole alebo väzbu, alebo sa nasadí nový modul, API, validácia aj dokumentácia existujú okamžite, len pre danú firmu a v rozsahu oprávnení volajúceho.

   Čítať podrobnejšie

   Dostupnosť entity rozhodujú tri kontroly: príznak API pri entite, zapnutý modul pri firme a oprávnenia volajúceho vrátane politiky API kľúča. Skrytá entita odpovie „nenájdené“ a neprezradí ani svoju existenciu. Trezor hesiel a preferencie cez API dostupné nie sú. Platí prihlásená relácia v prehliadači aj token v hlavičke, s rovnakými pravidlami a auditom ako aplikácia.

2. 2

   Čo API dokáže

   Pre každú entitu sú k dispozícii výpis, detail, založenie, úplná aj čiastočná úprava a mäkké zmazanie. Čiastočná úprava podporuje optimistické zamykanie podľa verzie záznamu, takže dve súbežné úpravy sa neprepíšu. K dispozícii je popis entity (polia, väzby, akcie), zoznam id filtrovanej množiny (až 500) a export (až 1 000 záznamov).

   Čítať podrobnejšie

   Hromadne možno založiť až 100 záznamov, upraviť až 500 a zmazať až 100; kombinácia založenia, úprav a zmazania prebehne v jednej transakcii. Výpočty vrátia súčty, priemery a ďalšie agregácie alebo počty zoskupené podľa poľa. API ďalej zvláda väzby (pripojenie, odpojenie, synchronizáciu), panely súvisiacich záznamov, históriu zmien, audit, prílohy, akcie nad záznamom aj nad výberom, prevody záznamov s náhľadom, ponuky na výber hodnôt a globálne vyhľadávanie.

   Riadené stavy menia len akcie.

3. 3

   Dopyty a filtre

   Filtre možno zapísať niekoľkými spôsobmi: hranatými zátvorkami, skupinami ALEBO, vnoreným stromom, skráteným zápisom typu amount>=10000, v JSON alebo uloženým filtrom. K dispozícii je fulltextové hľadanie, radenie, stránkovanie (predvolené 20, najviac 200 záznamov na stránku), výber polí a pripojenie súvisiacich záznamov.

   Čítať podrobnejšie

   Operátory pokrývajú porovnanie, obsahuje, začína, rozsahy, prázdne hodnoty, výbery z viacerých hodnôt, dátumové predvoľby ako tento mesiac alebo posledných 30 dní a väzbu na aktuálneho používateľa či jeho tím. Neznáme pole, pole bez práva čítania alebo nepovolený operátor API odmietne, takže filtrom nemožno vyzvedať dáta, ku ktorým volajúci nemá prístup.

4. 4

   Dokumentácia, prihlásenie a limity

   Dokument OpenAPI 3.1.2 sa generuje za behu z metadát a z pohľadu volajúceho: entity a operácie, ktoré nesmie používať, v ňom nie sú. Správca ho v administrácii prehliada v zobrazení Scalar. Validácia a dokumentácia používajú rovnaké definície, takže sa pri pokrytých cestách nerozchádzajú.

   Čítať podrobnejšie

   Token získate prihlásením (s kódom druhého faktora, ak je zapnutý) alebo podpisom SSH kľúčom pre agentov v príkazovom riadku. API kľúče a MCP tokeny spravuje používateľ v profile. Limit je 240 požiadaviek za minútu na firmu a používateľa; po 10 neúspešných pokusoch s tokenom za minútu sa IP adresa obmedzí. Každé volanie s tokenom sa zapíše do prístupového logu.

5. 5

   Webhooky

   Odchádzajúci webhook je akcia vo workflow Automation. Spustí ju zmena alebo zmazanie záznamu, plán, ručné spustenie alebo doménová udalosť. Odošle POST, PUT alebo PATCH s vlastnými hlavičkami a šablónou tela. Cieľová adresa prechádza ochranou proti SSRF, presmerovania sú vypnuté a časový limit je 30 sekúnd. Požiadavka nenesie podpis; neúspešné volanie sa zaloguje a opakuje len pri atomickom workflow alebo akcii so zastavením pri chybe.

   Čítať podrobnejšie

   Prichádzajúci webhook prijíma dáta na vlastnej adrese chránenej zdieľaným tajomstvom v hlavičke. Spracuje ich obsluha registrovaná modulom, napríklad príjem leadov do CRM, nahrávky hovorov alebo push z Mattermostu. Každé volanie sa zaloguje aj s výsledkom.