Automatikus REST API és webhookok

03Hogyan működik

Hogyan működik lépésről lépésre.

1. 1

   Hogyan működik az automatikus API?

   Az API nem tartalmaz külön kódot az egyes entitásokhoz. Egyetlen általános útvonalkészlet szolgál ki minden entitást, amelyet a rendszer ismer. Amikor a rendszergazda új entitást, mezőt vagy kapcsolatot ad hozzá, illetve amikor új modult telepítenek, az API, a validáció és a dokumentáció azonnal létrejön – kizárólag az adott vállalat számára és a hívó fél jogosultsági körében.

   Részletesebben

   Az entitás elérhetőségéről három ellenőrzés dönt: az entitás API-jelzője, a vállalatnál bekapcsolt modul, valamint a hívó fél jogosultsága, beleértve az API-kulcs szabályzatát is. A rejtett entitás „nem található” válasszal tér vissza, így még a létezését sem árulja el. A jelszótrezor és a felhasználói beállítások API-n keresztül nem érhetők el. A böngészőbeli bejelentkezett munkamenet és a fejlécben küldött token egyaránt használható, az alkalmazással azonos szabályok és auditnaplózás mellett.

2. 2

   Mire képes az API?

   Minden entitáshoz elérhető a listázás, a részletes nézet, a létrehozás, a teljes és részleges módosítás, valamint a puha törlés (soft delete). A részleges módosítás támogatja a rekordverzió szerinti optimista zárolást, így két egyidejű szerkesztés nem írja felül egymást. Lekérdezhető az entitás leírása (mezők, kapcsolatok, műveletek), a szűrt halmaz azonosítóinak listája (legfeljebb 500 elemig) és az export (legfeljebb 1 000 rekordig).

   Részletesebben

   Tömegesen legfeljebb 100 rekord hozható létre, 500 módosítható és 100 törölhető; a létrehozások, módosítások és törlések kombinációja egyetlen tranzakcióban fut le. A számítások összegeket, átlagokat és további aggregációkat, illetve mező szerint csoportosított darabszámokat adnak vissza. Az API emellett kezeli a kapcsolatokat (hozzárendelés, leválasztás, szinkronizálás), a kapcsolódó rekordok paneljeit, a változásnaplót, az auditot, a mellékleteket, az egyedi rekordokon és a kijelöléseken végzett műveleteket, az előnézettel támogatott rekordkonverziókat, az értékválasztó listákat és a globális keresést.

   A vezérelt állapotokat kizárólag műveletek módosíthatják.

3. 3

   Lekérdezések és szűrők

   A szűrők többféleképpen is megadhatók: szögletes zárójelekkel, VAGY-csoportokkal, egymásba ágyazott fastruktúrával, amount>=10000 típusú rövidített jelöléssel, JSON-formátumban vagy mentett szűrővel. Rendelkezésre áll a teljes szöveges keresés, a sorba rendezés, a lapozás (alapértelmezetten 20, oldalanként legfeljebb 200 rekord), a mezők kiválasztása és a kapcsolódó rekordok csatolása.

   Részletesebben

   Az operátorok lefedik az összehasonlítást, a tartalmazást, a szövegkezdetet, a tartományokat, az üres értékeket, a többértékű kiválasztást, az olyan dátum-előbeállításokat, mint az aktuális hónap vagy az elmúlt 30 nap, valamint az aktuális felhasználóhoz vagy csapatához való kapcsolódást. Az ismeretlen mezőt, az olvasási jogosultság nélküli mezőt vagy a nem engedélyezett operátort az API elutasítja, így szűrőkkel sem lehet olyan adatokat kipuhatolni, amelyekhez a hívó félnek nincs hozzáférése.

4. 4

   Dokumentáció, hitelesítés és korlátok

   Az OpenAPI 3.1.2 dokumentum futásidőben, a metaadatokból és a hívó fél szemszögéből generálódik: azok az entitások és műveletek, amelyeket nem használhat, nem szerepelnek benne. A rendszergazda az adminisztrációs felületen Scalar nézetben böngészheti. A validáció és a dokumentáció ugyanazokat a definíciókat használja, így a lefedett útvonalaknál soha nem térnek el egymástól.

   Részletesebben

   Tokent bejelentkezéssel (bekapcsolt kétfaktoros hitelesítés esetén a második faktor kódjával), vagy parancssori ügynökök esetén SSH-kulcsos aláírással szerezhet. Az API-kulcsokat és az MCP-tokeneket a felhasználó a profiljában kezeli. A korlát percenként 240 kérés vállalatonként és felhasználónként; percenként 10 sikertelen tokenes próbálkozás után a rendszer korlátozza az IP-címet. Minden tokennel végzett hívás bekerül a hozzáférési naplóba.

5. 5

   Webhookok

   A kimenő webhook egy művelet az Automation munkafolyamatban. Elindíthatja rekord módosítása vagy törlése, ütemezés, kézi indítás vagy tartományi esemény. Egyéni fejlécekkel és törzssablonnal ellátott POST, PUT vagy PATCH kérést küld. A célcím SSRF elleni védelmen megy keresztül, az átirányítások ki vannak kapcsolva, az időkorlát pedig 30 másodperc. A kérés nem hordoz aláírást; a sikertelen hívást a rendszer naplózza, és csak atomi munkafolyamat vagy hiba esetén megálló művelet esetén ismétli meg.

   Részletesebben

   A bejövő webhook saját, a fejlécben megosztott titokkal védett címen fogadja az adatokat. Ezeket a modul által regisztrált kezelő dolgozza fel, például a CRM-be érkező leadek fogadásakor, hívásfelvételeknél vagy a Mattermostból érkező push értesítéseknél. Minden hívás az eredménnyel együtt naplózásra kerül.