Kako pozvati vanjski API iz Workspace Studija

Tijek rada Google Workspace Studija može zahtijevati podatke izvan Gmaila, Diska ili Chata: status narudžbe, broj iz baze podataka ili odgovor internog alata. Da biste dohvatili te podatke ili poslali informacije drugoj usluzi, možete dodati korak Pošalji webhookOvim se šalje HTTP zahtjev na adresu API-ja koji ste naveli.

Ne morate konfigurirati poziv funkcije Gemini da biste uputili taj zahtjev. U Workspace Studiju, tijek izvršava korak webhooka i prima odgovor. Zatim, ako vam je koristan, taj odgovor možete proslijediti drugom koraku kako biste ga saželi, izdvojili podatke ili prenijeli rezultat.

Što vam je potrebno prije povezivanja s API-jem

Prvi korak je provjeriti može li vaša organizacija koristiti webhookove. Funkcija se nalazi u ograničeni pregled i onemogućeno je prema zadanim postavkama. Administrator se mora prijaviti. Aplikacije > Google Workspace > Workspace Studio > Postavke webhooka i omogućite ga za odgovarajuću organizacijsku jedinicu.

U nekim izdanjima administrator može ograničiti veze na jednu popis dopuštenih domena i URL-ovaAko se korak pojavi u Studiju, ali ne uspije komunicirati s vašim API-jem, provjerite je li odredišna adresa autorizirana. Također, prema zadanim postavkama, radnje koje uključuju webhookove zahtijevaju od korisnika da pregleda i potvrdi korak prije izvršenja.

Od vanjske usluge morate znati njezin URL, HTTP metode koje podržava i format podataka koji očekuje. Također, provjerite kako se autentificira: javni API samo za čitanje ima drugačije zahtjeve od privatnog API-ja koji zahtijeva tokene ili posebna zaglavlja.

Kako korak po korak pozvati API iz Workspace Studija

Unesi studio.workspace.google.com i stvorite tijek rada s okidačem koji vam je potreban. Na primjer, možete ga pokrenuti kada stigne e-pošta koja ispunjava određene uvjete. Zatim slijedite ove korake:

1. Pritisnite Dodaj korak i odaberite Pošalji webhook.
2. Unesite Puni URL API-ja, uključujući prefiks https://Adresa mora biti fiksna: ovo polje ne podržava varijable protoka.
3. Odaberite HTTP metodu. DOBITI Koristi se za upite podataka; POŠTAposlati ih ili stvoriti zapis. Također su dostupni STAVI, ZAKRPI i IZBRIŠI.
4. Ako API zahtijeva tijelo, napišite ga u polje sadržaja ili korisni teretGoogle preporučuje korištenje JSON-a kada ga usluga primatelja očekuje.
5. Napravite izvršenje testaProvjerite rezultat i aktivirajte tok nakon što ste potvrdili da radi.

Imajte na umu da test izvrši radnjuAko konfigurirate POST za stvaranje zapisa ili DELETE za njegovo brisanje, prvo upotrijebite testno okruženje ili podatke koje možete mijenjati bez problema.

Primjer: slanje obavijesti vanjskom alatu

Zamislite da vaš tim ima API koji stvara upozorenja u https://api.ejemplo.com/v1/avisosOva adresa je ilustrativanMorat ćete ga zamijeniti onim iz vaše usluge. Ako dokumentacija pokazuje da prihvaća POST i JSON tijelo, možete konfigurirati korak sa sadržajem poput {"tipo":"nuevo_correo","origen":"Workspace Studio"}.

Također možete umetnuti varijabla protoka U tijelu, na primjer, da biste uključili predmet e-pošte koja ju je pokrenula. Učinite to iz Studiovog odabira varijabli i provjerite rezultat: ako umetnuti tekst sadrži navodnike ili druge posebne znakove, JSON bi mogao biti neispravan. Varijable se mogu koristiti u sadržaju, ali nije u polju URL-a.

Ako trebate dohvatiti podatke, odaberite GET i unesite fiksni URL koji već sadrži potrebne parametre. Workspace Studio će zanemariti sav sadržaj koji ste napisali u tijelu GET zahtjeva.

Što učiniti s API odgovorom

Korak webhooka napušta odgovor usluge kao tekst u varijabli dostupnoj za sljedeće korake. Možete je koristiti za slanje obavijesti, pisanje sažetka ili traženje od koraka umjetne inteligencije da izdvoji određene podatke.

Na primjer, ako API vrati status narudžbe, sljedeći korak može prenijeti taj status timu. Izričito odaberite varijablu koja sadrži odgovor: sljedeći koraci ne primaju automatski sve što se dogodilo ranije u toku. Preporučljivo je testirati vraćeni sadržaj prije pisanja uputa koje ovise o njemu.

Ako API zahtijeva autentifikaciju ili složeniju logiku

Dokumentirana osnovna konfiguracija za Pošalji webhook Uključuje URL, metodu i opcionalno tijelo. Ako vaša integracija treba dobiti OAuth token, konstruirati URL s varijabilnim parametrima, dodati određena zaglavlja ili transformirati odgovor prije nego što nastavite, provjerite pokriva li ovaj korak te zahtjeve.

Kada to ne uspije, jedna od mogućnosti je razviti Prilagođeni korak za Workspace Studio putem dodatka. U implementaciji Google Apps Scripta, usluga UrlFetchApp Omogućuje vam slanje zahtjeva vanjskim API-jima i obradu JSON odgovora. Ovo rješenje zahtijeva razvoj i pravilnu konfiguraciju dozvola; nije potrebno za jednostavne zahtjeve koje izvorni korak već može obraditi.

Izbjegavajte lijepljenje privatnih ključeva u vidljiva polja toka ili njihovo ugrađivanje u dijeljeni URL. Prije slanja podataka iz Gmaila, Chata ili Kalendara provjerite koje će informacije vanjska usluga primiti i je li ovlaštena za njihovu obradu.

Kako pronaći greške u webhooku

Ako veza ne uspije, otvorite karticu Aktivnost tijeka. Tamo možete vidjeti cijelu pogrešku i odgovor koji je poslao odredišni poslužitelj. Ove informacije pomažu u razlikovanju problema s konfiguracijom Studija od zahtjeva koji je API odbio.

• Korak se ne prikazuje: Provjerite sa svojim administratorom jesu li webhookovi omogućeni za vašu organizacijsku jedinicu.
• URL je blokiran: Provjerite popis dopuštenih adresa ako vaše izdanje koristi to ograničenje.
• Pogreška 400: Provjerite format tijela i polja koja zahtijeva API.
• Pogreška 401 ili 403: Pregledajte dopuštenja i metodu autentifikacije koju zahtijeva usluga.
• Pogreška 429: Provjerite jeste li prekoračili ograničenje zahtjeva za ciljni API.
• Pogreška 500: Provjerite status i zapise usluge koja prima zahtjev.

Također imajte na umu opća ograničenja Workspace Studija: trenutno podržava do 25 tokova po korisniku y 20 koraka po tokuOsim toga, postoji kombinirano ograničenje izvršavanja koje se resetira svakih 24 sata. Ako se više tokova zaustavi, pregledajte njihovu aktivnost prije nego što kvar pripišete API-ju.

Za većinu jednostavnih HTTP veza, postupak je jednostavan: omogućite webhook, konfigurirajte fiksni URL i ispravnu metodu, testirajte zahtjev i koristite odgovor u sljedećim koracima. Ako integracija zahtijeva naprednu autentifikaciju ili transformaciju podataka putem koda, tada ima smisla pripremiti prilagođeni korak.