Prilagođene API integracije

Povežite vašeg chatbota sa prilagođenim API-jima

Koristeći naš uređivač AI akcija možete da napravite bilo koju prilagođenu integraciju sa bilo kojim pozadinskim sistemom koji može da izloži podatke putem API krajnjih tačaka (endpoints). Na primer, možete podesiti da chatbot proveri dostupnost proizvoda u vašem skladištu, proveri status porudžbine u vašem ERP sistemu ili proveri trenutno stanje na računu korisnika.

Takođe možete izvršavati akcije radi ažuriranja spoljnih sistema - na primer, pozivati krajnje tačke koje zakazuju sastanke ili pozivati Webhooks.

Preduslovi

ℹ️ Pre nego što počnete - proverite da li imate ChatLab pretplatu koja omogućava integracije sa prilagođenim API-jima (Custom API). Pogledajte stranicu sa cenama

Dodavanje Custom API-ja vašem chatbotu

Integracija prilagođenog API-ja omogućava vašem chatbotu da komunicira sa spoljnim servisima - na primer sa vašom prilagođenom prodavnicom, preuzimajući podatke ili izvršavajući akcije u ime korisnika.

Ovaj vodič će vas provesti kroz korake potrebne za podešavanje prilagođenog API-ja pomoću ChatLab platforme.

Vaš API

Potrebno je da imate javno dostupne API krajnje tačke koje chatbot može da pozove - to znači da treba da izložite podatke iz vaše e-commerce platforme ili prilagođenog sistema putem API krajnjih tačaka kako bi naš chatbot mogao da poziva te krajnje tačke radi preuzimanja ovih podataka i njihovog pružanja vašim korisnicima.

Pozivanje API-ja od strane chatbota

Chatbot će dinamički pozivati API tokom interakcije sa korisnikom, na osnovu potrebe chatbota da pristupi spoljnim podacima ili izvrši određene akcije. Važno je obratiti pažnju na sledeće:

• Nema garantovanog pozivanja: API će biti pozvan samo kada logika chatbota utvrdi da je to neophodno. Nema garancija o tome kada će ili koliko često API biti pozivan.

• Zahtevi za AI model: Za optimalne performanse preporučuje se korišćenje naprednijih AI modela koji podržavaju složeno pozivanje funkcija (function calling), kao što su GPT-4o ili noviji. Ovi modeli uspešnije određuju odgovarajuće trenutke za pozivanje API-ja na osnovu konteksta razgovora i namere korisnika.

• Pozivi svesni konteksta: Chatbot će pokušati da pozove API kad god prepozna kontekst u razgovoru koji odgovara svrsi API-ja, ali sam poziv zavisiće od više faktora, kao što su:

  • Dostupnost i brzina odgovora spoljnog API-ja.
  • Trenutno stanje razgovora i upiti korisnika.
  • Interni nivoi pouzdanosti i algoritmi bodovanja AI modela pri donošenju odluke o neophodnosti poziva.

Koraci za podešavanje prilagođenog API-ja (Custom API)

Korak 1: Idite na podešavanja Custom API

1. Prijavite se na vašu ChatLab kontrolnu tablu.

2. U bočnoj traci sa leve strane, u odeljku Settings (Podešavanja), kliknite na Custom API (Prilagođeni API).

Korak 2: Definišite novi API

1. Kliknite na dugme + Define API (+ Definiši API).

2. Unesite naziv vašeg API-ja u polje API Name (Naziv API-ja).

3. U polju URL navedite osnovni URL spoljnog servisa sa kojim želite da se povežete.

4. Kliknite na Save (Sačuvaj) da biste kreirali API.

Korak 3: Dodajte operacije API-ja

1. U novokreiranom API unosu kliknite na dugme View (Pregled).

2. Kliknite na + Define API Operation (+ Definiši operaciju API-ja) da biste podesili pojedinačne operacije (krajnje tačke) za API.

3. Popunite tražene podatke:

• Operation Name: Opisni naziv za operaciju.
• Operation URI: Putanja krajnje tačke za operaciju (npr. /v1/resource).

Korak 4: Konfigurišite URI krajnje tačke i parametre

1. Konfiguracija URI-ja krajnje tačke:

• Dodajte promenljive putanje potrebne za operaciju klikom na + Add path variable (+ Dodaj promenljivu putanje).
• Unesite detalje o promenljivoj i označite ih kao obavezne ukoliko je potrebno.

• Izaberite izvor vrednosti:
  • Provided by user to chatbot - u slučaju da je potrebna vrednost od korisnika da bi se ovo popunilo.
  • Constant - u slučaju da je ovo fiksna vrednost koju ćete navesti u trenutku definisanja API operacije.
• Dodajte novododatu promenljivu putanje u definiciju putanje između dva znaka „@”: @myvariable@:

1. Parametri upita (Query Parameters):

• Dodajte parametre upita klikom na + Add query parameter (+ Dodaj parametar upita).
• Definišite naziv parametra, tip podataka i izvor (npr. obezbeđuje korisnik ili chatbot).

Korak 5: Podesite metod zahteva i telo zahteva (Body)

1. Izaberite HTTP metod za operaciju (npr. GET, POST).

2. Ako je metod zahteva POST, konfigurišite telo zahteva (request body):

• Izaberite tip sadržaja (npr. application/json).
• Dodajte parametre tela zahteva, navodeći naziv, tip podataka i izvor.

• Dodajte promenljive u definiciju tela zahteva - to je obično JSON u koji možete postaviti definisane promenljive.

Korak 6: Podesite zaglavlja operacije

Dodajte zaglavlja - npr. Authorization ili druga koja zahteva vaš API. Pogledajte snimak ekrana ispod za podešavanje trajnog tokena u Authorization zaglavlju:

Korak 7: Sačuvajte operaciju

1. Pregledajte konfiguraciju kako biste se uverili da su svi detalji tačni.

2. Kliknite na Save changes (Sačuvaj izmene) da biste sačuvali operaciju API-ja.

Korak 8: Testirajte integraciju API-ja

1. Upotrebite funkciju Test API (Testiraj API) da biste poslali probni zahtev i osigurali da integracija radi ispravno.

2. Pratite zapise (logs) radi eventualnih grešaka ili problema i prilagodite konfiguraciju po potrebi.

Korak 9: Povežite operacije API-ja sa chatbotom

Kada su API Operations definisane, vreme je da ih dodelite chatbotu. Izaberite chatbota na glavnoj kontrolnoj tabli chatbotova, kliknite na Integrations (Integracije) i izaberite AI API Actions (AI API akcije) u levom meniju.

Kliknite na Attach (Poveži) kod izabrane operacije API-ja.

Korak 10: Dodajte uputstva o ulozi za chatbota

Izaberite vašeg chatbota na glavnoj kontrolnoj tabli chatbotova, kliknite na Settings (Podešavanja), pa u levom meniju izaberite Role (Uloga).

Kliknite na Provide custom role instructions. (Navedite prilagođena uputstva o ulozi.)

Dodajte uputstva za korišćenje novododate operacije API-ja, na primer možete dodati pravilo:

„- Kada korisnik pita za stanje zaliha u prodavnici, uvek pozovi funkciju getItems i prikaži rezultat funkcije prema sledećim pravilima…..”

Saveti za uspešnu integraciju

• Proverite da li su osnovni URL i krajnje tačke tačni i dostupni.

• Proverite da li su svi zahtevi za autentifikaciju (poput API ključeva ili tokena) ispravno konfigurisani.

• Temeljno testirajte svaku operaciju kako biste se uverili da vraća očekivane odgovore.

Prateći ove korake, možete jednostavno da integrišete prilagođene API-je u vaš ChatLab chatbot, proširujući njegovu funkcionalnost i pružajući bogatije korisničko iskustvo.

Bezbednost vaše Custom API integracije

Kako biste osigurali da vaš prilagođeni API bude bezbedan i zaštićen od neovlašćenog pristupa, razmotrite sledeće najbolje prakse:

Koristite stalne tokene

Stalni API tokeni: Podesite stalni API token (ili ključ) koji je obavezan za sve zahteve upućene API-ju. Ovaj token treba da bude jedinstven i generisan na bezbedan način.

• Kako primeniti: Uključite token u zaglavlje zahteva ili kao parametar upita u svakom API pozivu.

• Gde sačuvati: Čuvajte token bezbedno u vašim ChatLab podešavanjima kao fiksni parametar operacije.

Koristite krajnju tačku za prijavu za privremene tokene

Dodajte dodatnu operaciju u API koja vraća privremeni bezbednosni token - tj. krajnju tačku za prijavu na vaš sistem.

Moraćete da navedete podatke za prijavu koji odgovaraju vašem sistemu kao fiksne parametre API operacije prilikom definisanja te operacije. Da bi chatbot mogao da koristi token dobijen na ovaj način, potrebno je da dodate bezbednosni token u definicije drugih API operacija i dodate odgovarajuća prompt uputstva kako operaciji za prijavu, tako i ostalim API operacijama (na primer: „Uvek koristi bezbednosni token dobijen iz Login operacije kao security_token parametar za operaciju getOrder”).

Kontrola osetljivih informacija putem ChatLaba

Da bi sprečili prikazivanje osetljivih informacija od strane chatbota, korisnici ChatLaba mogu preduzeti sledeće korake:

Koristite inženjering promptova za usmeravanje ponašanja AI-ja

• Postavite jasna uputstva u promptovima: Prilikom konfigurisanja chatbota navedite izričita uputstva u podešavanjima prompta kako bi se izbeglo prikazivanje bilo kakvih osetljivih informacija. Na primer:

  • Primer prompta: „Nemoj prikazivati nikakve lične, finansijske ili poverljive podatke vraćene iz API poziva.”
  • Korišćenje sistemskih poruka: Uključite sistemsku poruku na početku toka razgovora kako biste naglasili važnost privatnosti podataka (npr. „Osiguraj da svi odgovori isključe bilo kakve osetljive informacije.”).

• Redovno ažurirajte promptove: Prilagođavajte promptove na osnovu povratnih informacija korisnika ili promena u zahtevima za osetljivost podataka. To pomaže da AI dosledno prati najnovije smernice za rukovanje osetljivim informacijama.

Projektujte API krajnje tačke sa ugrađenom logikom provere

• Zahtevajte verifikaciju korisnika za pristup osetljivim podacima: Projektujte vaše API krajnje tačke tako da uključuju provere pre vraćanja osetljivih podataka. Na primer:

  • Parametri verifikacije: Zahtevajte od korisnika da unesu određene podatke (kao što su imejl adresa, broj porudžbine ili specifično bezbednosno pitanje) pre nego što API vrati podatke koji se odnose na tog korisnika.
  • Višefaktorska provera: Primenite dodatne parametre (npr. datum porudžbine, adresa za dostavu ili tajni kod) da biste verifikovali identitet korisnika i osigurali da ima ovlašćenje za pristup podacima.

• Primenite bezbedne odgovore (Fail-Safe): Podesite logiku API-ja tako da vraća generičke poruke ili greške ukoliko se ne unese tražena provera ili ako se podaci ne poklapaju:

  • Primer: „Nije moguće preuzeti detalje porudžbine. Molimo vas da proverite vašu imejl adresu i broj porudžbine.”

Koristite ograničene opsege podataka u API odgovorima

• Smanjite izloženost podataka: Konfigurišite API odgovore tako da sadrže samo one podatke koji su neophodni za rad chatbota, smanjujući time rizik od nenamernog prikazivanja osetljivih informacija.
  • Primer: Umesto vraćanja kompletnih profila korisnika, vratite samo određena polja kao što su status porudžbine ili potvrda plaćanja koja su neophodna za zadatak chatbota.