Külső API meghívása a Workspace Studio-ból

Egy Google Workspace Studio munkafolyamatnak szüksége lehet a Gmailen, a Drive-on vagy a Chaten kívüli adatokra is: rendelési állapotra, adatbázisból származó számra vagy belső eszköz válaszára. Ezen adatok lekéréséhez vagy egy másik szolgáltatásba való elküldéséhez hozzáadhatja a következő lépést: Webhook küldéseEz egy HTTP kérést küld a megadott API címére.

Nem kell konfigurálnod a Gemini függvényhívást a kérés végrehajtásához. A Workspace Studio-ban a folyamat végrehajtja a webhook lépést és fogadja a választ. Ezután, ha hasznosnak találod, átadhatod a választ egy másik lépésnek az összegzéshez, az adatok kinyeréséhez vagy az eredmény közléséhez.

Amire szüksége van egy API-hoz való csatlakozás előtt

Az első lépés annak ellenőrzése, hogy a szervezete használhat-e webhookokat. A függvény itt található: korlátozott előnézet és alapértelmezés szerint le van tiltva. Egy rendszergazdának kell bejelentkeznie. Alkalmazások > Google Workspace > Workspace Studio > Webhook beállításai és engedélyezze azt a megfelelő szervezeti egység számára.

Bizonyos kiadásokban a rendszergazda egyre korlátozhatja a kapcsolatokat engedélyezett domainek és URL-ek listájaHa a lépés megjelenik a Studioban, de nem kommunikál az API-val, ellenőrizze, hogy a célcím engedélyezett-e. Alapértelmezés szerint a webhookokat tartalmazó műveletek megkövetelik a felhasználótól, hogy a végrehajtás előtt áttekintse és megerősítse a lépést.

A külső szolgáltatásról ismerned kell az URL-címét, a támogatott HTTP-metódusokat és a várt adatformátumot. Ellenőrizd azt is, hogyan hitelesít: egy nyilvános, csak olvasható API-nak más követelményei vannak, mint egy privát API-nak, amely tokeneket vagy speciális fejléceket igényel.

API meghívása a Workspace Studio-ból lépésről lépésre

Belépés studio.workspace.google.com és hozzon létre egy munkafolyamatot a szükséges triggerrel. Elindíthatja például, amikor egy bizonyos feltételeknek megfelelő e-mail érkezik. Ezután kövesse az alábbi lépéseket:

1. Sajtó Lépés hozzáadása és válassza ki Webhook küldése.
2. Írja be a Teljes URL az API-ból, beleértve az előtagot is https://A címet rögzíteni kell: ez a mező nem támogatja a folyamatváltozókat.
3. Válassza ki a HTTP metódust. KAP Adatok lekérdezésére szolgál; POSTAelküldeni őket, vagy létrehozni egy rekordot. Ezek szintén elérhetők PUT, PATCH és DELETE.
4. Ha az API törzset igényel, akkor azt a tartalom mezőbe kell írni, vagy hasznos teherA Google a JSON használatát javasolja, amikor a fogadó szolgáltatás azt várja.
5. Készíts egy teszt végrehajtásaEllenőrizd az eredményt, és miután meggyőződtél róla, hogy működik, aktiváld a folyamatot.

Ne feledd, hogy a teszt hajtsa végre a műveletetHa POST utasítást konfigurálsz rekord létrehozására, vagy DELETE utasítást annak törlésére, először használj egy tesztkörnyezetet vagy olyan adatokat, amelyeket problémamentesen módosíthatsz.

Példa: értesítés küldése külső eszköznek

Képzeld el, hogy a csapatodnak van egy API-ja, amely riasztásokat hoz létre https://api.ejemplo.com/v1/avisosEz a cím szemléltetőKi kell cserélned a szolgáltatásodból származóval. Ha a dokumentációja azt jelzi, hogy elfogadja a POST-ot és a JSON törzset, akkor a lépést olyan tartalommal konfigurálhatod, mint a {"tipo":"nuevo_correo","origen":"Workspace Studio"}.

Beszúrhat egy áramlási változó A törzsben például az azt kiváltó e-mail tárgyának megadásához. Ezt a Studio változóválasztójából teheti meg, és ellenőrizze az eredményt: ha a beszúrt szöveg idézőjeleket vagy más speciális karaktereket tartalmaz, az a JSON-t hibásan formázhatja. Változók használhatók a tartalomban, de nincs az URL mezőben.

Ha adatokat kell lekérnie, válassza a GET lehetőséget, és adjon meg egy fix URL-címet, amely már tartalmazza a szükséges paramétereket. A Workspace Studio figyelmen kívül hagyja a GET kérés törzsébe írt tartalmat.

Mi a teendő az API válasszal?

A webhook lépés elhagyja a szolgáltatási válasz szövegként egy változóban, amely elérhető a következő lépésekhez. Használhatod értesítés küldésére, összefoglaló írására, vagy arra, hogy egy MI-lépéstől kérj meg bizonyos adatokat.

Például, ha az API visszaadja egy rendelés állapotát, a következő lépés kommunikálhatja ezt az állapotot a csapattal. Explicit módon válassza ki a választ tartalmazó változót: a következő lépések nem kapják meg automatikusan a folyamatban korábban történt összes eseményt. Célszerű tesztelni a visszaadott tartalmat, mielőtt olyan utasításokat írna, amelyek attól függenek.

Ha az API hitelesítést vagy összetettebb logikát igényel

A dokumentált alapkonfiguráció a következőhöz: Webhook küldése Tartalmazza az URL-t, a metódust és egy opcionális törzset. Ha az integrációnak OAuth tokent kell beszereznie, változó paraméterekkel rendelkező URL-t kell létrehoznia, adott fejléceket kell hozzáadnia, vagy egy választ kell átalakítania a folytatás előtt, ellenőrizze, hogy ez a lépés lefedi-e ezeket a követelményeket.

Amikor ez nem sikerül, az egyik lehetőség egy olyan fejlesztés, Egyéni lépés a Workspace Studio-hoz egy bővítményen keresztül. Egy Google Apps Script implementációban a szolgáltatás UrlFetchApp Lehetővé teszi külső API-khoz intézett kérések küldését és JSON-válaszok feldolgozását. Ez a megoldás fejlesztést és megfelelő jogosultságkonfigurációt igényel; ez nem szükséges az olyan egyszerű kérésekhez, amelyeket a natív lépés már képes kezelni.

Kerülje a privát kulcsok beillesztését a folyamat látható mezőibe, illetve a megosztott URL-címbe való beágyazását. Mielőtt adatokat küldene a Gmailből, a Chatből vagy a Naptárból, ellenőrizze, hogy a külső szolgáltatás milyen információkat fog kapni, és hogy jogosult-e azok feldolgozására.

Hogyan találjunk hibákat egy webhookban?

Ha a kapcsolat megszakad, nyissa meg a fület Tevékenység a folyamat. Ott megtekintheti a teljes hibát és a célkiszolgáló által küldött választ. Ez az információ segít megkülönböztetni a Studio konfigurációs problémáját az API által elutasított kéréstől.

• A lépés nem jelenik meg: Érdeklődjön a rendszergazdánál, hogy engedélyezve vannak-e a webhookok a szervezeti egységében.
• Az URL blokkolva van: Ellenőrizd az engedélyezett címek listáját, ha a kiadásod ezt a korlátozást használja.
• 400-as hiba: ellenőrizze a törzs formátumát és az API által megkövetelt mezőket.
• 401-es vagy 403-as hiba: Tekintse át a szolgáltatás által megkövetelt engedélyeket és hitelesítési módszert.
• 429-as hiba: Ellenőrizd, hogy túllépted-e a cél API kéréskorlátját.
• 500-as hiba: Ellenőrizze a kérést fogadó szolgáltatás állapotát és nyilvántartásait.

Ne feledkezzen meg a Workspace Studio általános korlátairól sem: jelenleg akár 25 folyamat felhasználónként y 20 lépés áramlásonkéntEzenkívül van egy kombinált végrehajtási korlát, amely 24 óránként visszaáll alaphelyzetbe. Ha több folyamat futása leáll, tekintse át a tevékenységüket, mielőtt a hibát az API-nak tulajdonítaná.

A legtöbb egyszerű HTTP-kapcsolat esetében a folyamat egyszerű: engedélyezd a webhookot, konfigurálj egy fix URL-címet és a helyes metódust, teszteld a kérést, és használd a választ a következő lépésekben. Ha az integráció speciális hitelesítést vagy adatátalakítást igényel kódon keresztül, akkor érdemes egyéni lépést előkészíteni.