Vlastné integrácie API

Prepojte svojho chatbota s vlastnými API

Pomocou nášho editora AI akcií môžete vytvoriť ľubovoľnú vlastnú integráciu s akýmkoľvek backendovým systémom, ktorý dokáže sprístupniť údaje cez API endpointy. Môžete napríklad nastaviť chatbota tak, aby overil dostupnosť produktu vo vašom sklade, skontroloval stav objednávky vo vašom ERP systéme alebo zistil aktuálny zostatok na účte zákazníka.

Môžete tiež spúšťať akcie na aktualizáciu externých systémov - napríklad volať endpointy, ktoré plánujú stretnutia alebo odosielajú webhooky.

Požiadavky

ℹ️ Skôr než začnete - uistite sa, že máte predplatné ChatLab, ktoré umožňuje integrácie vlastných API (Custom API). Pozrite si stránku s cenníkom

Pridanie vlastného API do vášho chatbota

Integrácia vlastného API umožňuje vášmu chatbotovi komunikovať s externými službami - napríklad s vaším vlastným e-shopom, získavať údaje alebo vykonávať akcie v mene používateľa.

Tento sprievodca vás prevedie krokmi potrebnými na nastavenie vlastného API pomocou platformy ChatLab.

Vaše API

Musíte mať verejne dostupné API endpointy, ktoré môže chatbot volať - to znamená, že musíte sprístupniť údaje zo svojej e-commerce platformy alebo vlastného systému prostredníctvom API endpointov, aby ich náš chatbot mohol volať, získať tieto údaje a poskytnúť ich vašim používateľom.

Volanie API chatbotom

API bude chatbot volať dynamicky počas interakcií s používateľom na základe potreby chatbota získať externé údaje alebo vykonať konkrétne akcie. Je dôležité mať na pamäti nasledovné:

• Žiadne garantované volanie: API sa vyvolá iba vtedy, keď logika chatbota vyhodnotí, že je to potrebné. Neexistujú žiadne záruky, kedy alebo ako často bude API volané.

• Požiadavky na model AI: Pre optimálny výkon sa odporúča používať pokročilejšie modely AI, ktoré podporujú komplexné volanie funkcií (function calling), ako napríklad GPT-4o alebo vyššie. Tieto modely dokážu lepšie určiť vhodné okamihy na vyvolanie API na základe kontextu konverzácie a zámeru používateľa.

• Volania závislé od kontextu: Chatbot sa pokúsi zavolať API vždy, keď v konverzácii identifikuje kontext zodpovedajúci účelu API, no samotné volanie bude závisieť od viacerých faktorov, ako napríklad:

  • Dostupnosť a rýchlosť odozvy externého API.
  • Aktuálny stav konverzácie a zadania používateľa.
  • Interná miera istoty a hodnotiace algoritmy modelu AI pri rozhodovaní o nevyhnutnosti volania.

Postup nastavenia Custom API

Krok 1: Prejdite do nastavení Custom API

1. Prihláste sa do svojho ovládacieho panelu ChatLab.

2. V ľavom bočnom paneli v sekcii Settings (Nastavenia) kliknite na Custom API (Vlastné API).

Krok 2: Definujte nové API

1. Kliknite na tlačidlo + Define API (+ Definovať API).

2. Zadajte názov svojho API do poľa API Name (Názov API).

3. Do poľa URL zadajte základnú URL adresu externej služby, ku ktorej sa chcete pripojiť.

4. Kliknutím na Save (Uložiť) API vytvorte.

Krok 3: Pridajte operácie API

1. Pri novovytvorenej položke API kliknite na tlačidlo View (Zobraziť).

2. Kliknite na + Define API Operation (+ Definovať operáciu API) a nastavte jednotlivé operácie (endpointy) pre dané API.

3. Vyplňte požadované údaje:

• Operation Name: Popisný názov operácie.
• Operation URI: Cesta endpointu pre danú operáciu (napr. /v1/resource).

Krok 4: Nakonfigurujte URI endpointu a parametre

1. Konfigurácia URI endpointu:

• Pridajte všetky premenné cesty potrebné pre operáciu kliknutím na + Add path variable (+ Pridať premennú cesty).
• Zadajte podrobnosti o premennej a v prípade potreby ich označte ako povinné.

• Vyberte zdroj hodnoty:
  • Provided by user to chatbot - v prípade, že je na vyplnenie potrebná hodnota od používateľa.
  • Constant - v prípade, že ide o konštantnú hodnotu, ktorú musíte zadať pri definovaní operácie API.
• pridajte novo pridanú premennú cesty do definície cesty medzi dva znaky „@“: @myvariable@:

1. Parametre dopytu (Query Parameters):

• Pridajte ľubovoľné parametre dopytu kliknutím na + Add query parameter (+ Pridať parameter dopytu).
• Definujte názov parametra, dátový typ a zdroj (napr. poskytnutý používateľom alebo chatbotom).

Krok 5: Nastavte metódu požiadavky a telo (Body)

1. Vyberte HTTP metódu pre operáciu (napr. GET, POST).

2. Ak je metóda požiadavky POST, nakonfigurujte telo požiadavky:

• Vyberte typ obsahu (napr. application/json).
• Pridajte parametre tela, pričom uveďte názov, dátový typ a zdroj.

• Pridajte premenné do definície tela - zvyčajne ide o JSON, do ktorého môžete vložiť premenné, ktoré ste definovali

Krok 6: Nastavte hlavičky operácie

Pridajte hlavičky - napr. Authorization alebo iné, ktoré vaše API vyžaduje. Pozrite si snímku obrazovky nižšie, kde je znázornené nastavenie trvalého tokenu v hlavičke Authorization:

Krok 7: Uložte operáciu

1. Skontrolujte konfiguráciu a uistite sa, že sú všetky údaje správne.

2. Kliknutím na Save changes (Uložiť zmeny) operáciu API uložte.

Krok 8: Otestujte integráciu API

1. Pomocou funkcie Test API (Testovať API) odošlite testovaciu požiadavku a overte, či integrácia funguje správne.

2. Sledujte záznamy (logy), či sa v nich nenachádzajú chyby alebo problémy, a podľa potreby upravte konfiguráciu.

Krok 9: Priraďte operácie API k chatbotovi

Keď máte zadefinované API Operations (Operácie API), je čas priradiť ich chatbotovi. Vyberte chatbota na hlavnom paneli chatbotov, kliknite na Integrations (Integrácie) a v ľavom menu vyberte AI API Actions (AI akcie API)

Kliknite na Attach (Priradiť) pri vybranej operácii API

Krok 10: Pridajte inštrukcie roly pre chatbota

Vyberte svojho chatbota na hlavnom paneli chatbotov, kliknite na Settings (Nastavenia) a v ľavom menu vyberte Role (Rola)

Kliknite na Provide custom role instructions (Zadať vlastné inštrukcie roly).

Pridajte inštrukcie na používanie novo pridanej operácie API, môžete napríklad pridať pravidlo:

„- Keď sa používateľ opýta na stav zásob v obchode, vždy zavolaj funkciu getItems a vykresli výsledok funkcie podľa nasledujúcich pravidiel...“

Tipy na úspešnú integráciu

• Uistite sa, že základná URL adresa a endpointy sú správne a dostupné.

• Overte, či sú správne nakonfigurované všetky požiadavky na overenie totožnosti (napríklad API kľúče alebo tokeny).

• Každú operáciu dôkladne otestujte, aby ste sa uistili, že vracia očakávané odpovede.

Podľa týchto krokov môžete bez problémov integrovať vlastné API do svojho chatbota v platforme ChatLab, rozšíriť jeho funkcie a poskytnúť používateľom kvalitnejší zážitok.

Zabezpečenie integrácie vlastného API

Ak chcete zabezpečiť, aby bolo vaše vlastné API chránené pred neoprávneným prístupom, zvážte nasledujúce osvedčené postupy:

Používajte konštantné tokeny

Konštantné API tokeny: Nastavte stály API token (alebo kľúč), ktorý sa vyžaduje pri všetkých požiadavkách na API. Tento token by mal byť jedinečný a bezpečne vygenerovaný.

• Ako to implementovať: Zahrňte token do hlavičky požiadavky alebo ako parameter dopytu pri každom volaní API.

• Kde ho uložiť: Uložte token bezpečne v nastaveniach ChatLab ako konštantný parameter danej operácie

Použite prihlasovací endpoint pre dočasné tokeny

Pridajte do API ďalšiu operáciu API, ktorá vracia dočasný bezpečnostný token - t. j. prihlasovací endpoint do vášho systému.

Pri definovaní tejto operácie API budete musieť zadať svoje prihlasovacie údaje zodpovedajúce vášmu systému ako konštantné parametre operácie API. Aby chatbot mohol používať takto získaný token, musíte pridať bezpečnostný token do definícií ostatných operácií API a pridať správne inštrukcie do promptu tak pre prihlasovaciu operáciu, ako aj pre ostatné operácie API (napríklad: „Vždy použi bezpečnostný token získaný z operácie Login ako parameter security_token pre operáciu getOrder“).

Kontrola citlivých informácií v službe ChatLab

Ak chcú používatelia služby ChatLab zabrániť chatbotovi zobrazovať citlivé informácie, môžu vykonať nasledujúce opatrenia:

Využite prompt engineering na usmernenie správania AI

• Nastavte jasné inštrukcie v prompte: Pri konfigurácii chatbota uveďte v nastaveniach promptu výslovné inštrukcie, aby nezobrazoval žiadne citlivé informácie. Napríklad:

  • Príklad promptu: „Nezobrazuj žiadne osobné, finančné ani dôverné informácie vrátené volaním API.“
  • Použitie systémových správ: Na začiatok konverzačného toku vložte systémovú správu, ktorá zdôrazní dôležitosť ochrany osobných údajov (napr. „Zaisti, aby žiadne výstupy neobsahovali citlivé informácie.“).

• Pravidelne aktualizujte prompty: Upravujte prompty na základe spätnej väzby od používateľov alebo zmien v požiadavkách na ochranu citlivých údajov. Pomôže to zabezpečiť, aby AI neustále dodržiavala najnovšie pravidlá zaobchádzania s citlivými informáciami.

Navrhujte API endpointy so zabudovanou logikou overovania

• Vyžadujte overenie používateľa pri prístupe k citlivým údajom: Navrhnite svoje API endpointy tak, aby pred vrátením citlivých údajov vykonali kontrolu overenia. Napríklad:

  • Overovacie parametre: Vyžadujte od používateľov zadanie určitých údajov (napríklad e-mailovej adresy, čísla objednávky alebo špecifickej bezpečnostnej otázky) predtým, ako API vráti údaje vzťahujúce sa k danému používateľovi.
  • Viacfaktorové overenie: Zaveďte dodatočné parametre (napr. dátum objednávky, dodaciu adresu alebo tajný kód), aby ste overili identitu používateľa a uistili sa, že má oprávnenie na prístup k údajom.

• Implementujte bezpečné predvolené odpovede (fail-safe): Nastavte logiku API tak, aby v prípade neposkytnutia alebo nezhody požadovaného overenia vrátila všeobecné správy alebo chyby:

  • Príklad: „Podrobnosti objednávky sa nepodarilo načítať. Overte svoj e-mail a číslo objednávky.“

Používajte obmedzený rozsah údajov v odpovediach API

• Minimalizujte vystavenie údajov: Nakonfigurujte odpovede API tak, aby obsahovali iba údaje nevyhnutné pre fungovanie chatbota, čím znížite riziko neúmyselného zobrazenia citlivých informácií.
  • Príklad: Namiesto vrátenia celých profilov používateľov vracajte iba konkrétne polia, ako je stav objednávky alebo potvrdenie platby, ktoré sú potrebné pre úlohu chatbota.