Vlastní API integrace

Integrace chatbota s vlastními API

Pomocí našeho editoru akcí AI můžete vytvořit libovolnou vlastní integraci s jakýmkoli backendovým systémem, který dokáže zpřístupnit data prostřednictvím koncových bodů API. Můžete například zařídit, aby chatbot ověřoval dostupnost produktu ve vašem skladu, zjišťoval stav objednávky ve vašem ERP systému nebo kontroloval aktuální zůstatek na účtu zákazníka.

Můžete také spouštět akce pro aktualizaci externích systémů - například volat koncové body pro sjednávání schůzek nebo webhooky.

Požadavky

ℹ️ Než začnete - ujistěte se, že máte předplatné ChatLab, které umožňuje integrace Custom API. Podívejte se na stránku s ceníkem

Přidání Custom API k vašemu chatbotovi

Integrace vlastního API umožňuje vašemu chatbotovi komunikovat s externími službami - například s vaším vlastním e-shopem, načítat data nebo provádět akce jménem uživatele.

Tento průvodce vás provede kroky potřebnými k nastavení vlastního API pomocí platformy ChatLab.

Vaše API

Musíte mít veřejně dostupné koncové body API, které může chatbot volat - to znamená, že musíte zpřístupnit data ze své e-commerce platformy nebo vlastního systému prostřednictvím koncových bodů API, aby tyto body mohl náš chatbot volat, získávat z nich data a poskytovat je vašim uživatelům.

Volání API chatbotem

API bude chatbot dynamicky volat během interakcí s uživatelem podle toho, zda chatbot potřebuje získat přístup k externím datům nebo provést konkrétní akce. Je důležité vzít na vědomí následující:

• Volání není zaručeno: API bude vyvoláno pouze tehdy, když logika chatbota vyhodnotí, že je to nutné. Neexistují žádné záruky ohledně toho, kdy nebo jak často bude API voláno.

• Požadavky na model AI: Pro optimální výkon doporučujeme používat vyšší modely AI, které podporují komplexní volání funkcí (function calling), jako je například GPT-4o nebo vyšší. Tyto modely dokážou lépe určit vhodné okamžiky pro vyvolání API na základě kontextu konverzace a záměru uživatele.

• Volání závislá na kontextu: Chatbot se pokusí zavolat API pokaždé, když v konverzaci rozpozná kontext odpovídající účelu daného API, ale samotné volání bude záviset na více faktorech, například:

  • Dostupnost a rychlost odezvy externího API.
  • Aktuální stav konverzace a uživatelské prompty.
  • Interní míra spolehlivosti a skórovací algoritmy modelu AI při rozhodování o nutnosti volání.

Postup nastavení Custom API

Krok 1: Přejděte do nastavení Custom API

1. Přihlaste se do ovládacího panelu ChatLab.

2. V levém postranním panelu v sekci Settings (Nastavení) klikněte na Custom API (Vlastní API).

Krok 2: Definujte nové API

1. Klikněte na tlačítko + Define API (+ Definovat API).

2. Do pole API Name (Název API) zadejte název vašeho API.

3. Do pole URL zadejte základní URL adresu externí služby, ke které se chcete připojit.

4. Kliknutím na Save (Uložit) API vytvořte.

Krok 3: Přidejte operace API

1. U nově vytvořené položky API klikněte na tlačítko View (Zobrazit).

2. Klikněte na + Define API Operation (+ Definovat operaci API) a nastavte jednotlivé operace (koncové body) pro dané API.

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

• Operation Name: Popisný název operace.
• Operation URI: Cesta ke koncovému bodu operace (např. /v1/resource).

Krok 4: Nakonfigurujte URI a parametry koncového bodu

1. Konfigurace URI koncového bodu:

• Kliknutím na + Add path variable přidejte proměnné cesty potřebné pro operaci.
• Zadejte podrobnosti o proměnné a v případě potřeby ji označte jako povinnou.

• Zvolte zdroj hodnoty:
  • Provided by user to chatbot - v případě, že k jejímu vyplnění je vyžadována hodnota od uživatele.
  • Constant - v případě, že jde o konstantní hodnotu, kterou budete muset zadat v okamžiku definice operace API.
• Přidejte nově přidanou proměnnou cesty do definice cesty mezi dva znaky „@“: @myvariable@:

1. Parametry dotazu (Query Parameters):

• Kliknutím na + Add query parameter přidejte parametry dotazu.
• Definujte název parametru, datový typ a zdroj (např. poskytnuto uživatelem nebo chatbotem).

Krok 5: Nastavte metodu požadavku a tělo

1. Zvolte HTTP metodu pro danou operaci (např. GET, POST).

2. Pokud je metodou požadavku POST, nakonfigurujte tělo požadavku:

• Vyberte typ obsahu (např. application/json).
• Přidejte parametry těla a zadejte název, datový typ a zdroj.

• Přidejte proměnné do definice těla - obvykle se jedná o formát JSON, do kterého můžete umístit proměnné, jež jste definovali.

Krok 6: Nastavte hlavičky operace

Přidejte hlavičky - např. Authorization nebo další hlavičky vyžadované vaším API. Podívejte se na níže uvedený snímek obrazovky pro nastavení trvalého tokenu v hlavičce Authorization:

Krok 7: Uložte operaci

1. Zkontrolujte konfiguraci a ujistěte se, že jsou všechny údaje správné.

2. Kliknutím na Save changes (Uložit změny) operaci API uložte.

Krok 8: Otestujte integraci API

1. Pomocí funkce Test API (Otestovat API) odešlete zkušební požadavek a ověřte, že integrace funguje správně.

2. Sledujte v protokolech případné chyby nebo problémy a podle potřeby upravte konfiguraci.

Krok 9: Přiřaďte operace API k chatbotovi

Jakmile máte operace API Operations definované, je čas je přiřadit k chatbotovi. Na hlavním přehledu chatbotů vyberte chatbota, klikněte na **Integrations ** (Integrace) a v levé nabídce vyberte **AI API Actions ** (Akce AI API).

Klikněte na Attach (Připojit) u vybrané operace API.

Krok 10: Přidejte pokyny pro roli chatbota

Na hlavním přehledu chatbotů vyberte svého chatbota, klikněte na **Settings, ** (Nastavení) a v levé nabídce vyberte Role (Role).

Klikněte na Provide custom role instructions. (Zadat vlastní instrukce role).

Přidejte pokyny k používání nově přidané operace API, můžete například přidat pravidlo:

“- When user asks for store inventory always call getItems function and render the result of the function with following rules…..”

Tipy pro úspěšnou integraci

• Ujistěte se, že základní URL adresa i koncové body jsou správné a dostupné.

• Ověřte, že jsou správně nakonfigurovány veškeré požadavky na ověření (např. klíče API nebo tokeny).

• Každou operaci důkladně otestujte, abyste se ujistili, že vrací očekávané odpovědi.

Podle těchto kroků můžete do svého chatbota v ChatLabu hladce integrovat vlastní API, rozšířit jeho funkce a poskytnout uživatelům plnohodnotnější prostředí.

Zabezpečení integrace Custom API

Chcete-li zajistit, aby vaše vlastní API bylo bezpečné a chráněné před neoprávněným přístupem, zvažte následující doporučené postupy:

Používejte konstantní tokeny

Konstantní tokeny API: Nastavte konstantní token (nebo klíč) API, který je vyžadován pro všechny požadavky na API. Tento token by měl být jedinečný a bezpečně vygenerovaný.

• Způsob implementace: Zahrňte token do hlavičky požadavku nebo jako parametr dotazu při každém volání API.

• Kde jej uložit: Uložte token bezpečně v nastavení ChatLab jako konstantní parametr dané operace.

Používejte přihlašovací koncový bod pro dočasné tokeny

Přidejte do API další operaci, která vrací dočasný bezpečnostní token - tj. přihlašovací koncový bod do vašeho systému.

Při definování této operace API budete muset zadat své přihlašovací údaje odpovídající vašemu systému jako konstantní parametry operace API. Aby mohl chatbot takto získaný token používat, musíte bezpečnostní token přidat do definic ostatních operací API a přidat správné pokyny v promptu jak k přihlašovací operaci, tak k ostatním operacím API (například „Always use the security token obtained from the Login operation as the security_token parameter for operation getOrder“).

Správa citlivých informací v ChatLabu

Chcete-li zabránit tomu, aby chatbot zobrazoval citlivé informace, můžete v ChatLabu podniknout následující kroky:

Využijte prompt engineering k usměrnění chování AI

• Nastavte v promptech jasné pokyny: Při konfiguraci chatbota zadejte v nastavení promptu výslovné pokyny, aby nezobrazoval žádné citlivé údaje. Například:

  • Příklad promptu: „Nezobrazujte žádné osobní, finanční ani důvěrné informace vrácené voláním API.“
  • Použití systémových zpráv: Zahrňte systémovou zprávu na začátek toku konverzace, abyste zdůraznili důležitost ochrany osobních údajů (např. „Zajistěte, aby všechny výstupy vylučovaly jakékoli citlivé informace.“).

• Pravidelně prompty aktualizujte: Upravujte prompty na základě zpětné vazby od uživatelů nebo změn v požadavcích na citlivost dat. Tím zajistíte, že AI bude důsledně dodržovat nejnovější pokyny pro nakládání s citlivými informacemi.

Navrhujte koncové body API s integrovanou logikou ověřování

• Vyžadujte ověření uživatele pro přístup k citlivým datům: Navrhněte koncové body API tak, aby před vrácením citlivých dat zahrnovaly ověřovací kontroly. Například:

  • Ověřovací parametry: Vyžadujte od uživatelů zadání určitých údajů (například e-mailové adresy, čísla objednávky nebo konkrétní bezpečnostní otázky) ještě předtím, než API vrátí data vztahující se k tomuto uživateli.
  • Vícefaktorové ověření: Zaveďte další parametry (např. datum objednávky, doručovací adresu nebo tajný kód) k ověření totožnosti uživatele a zajištění toho, že je oprávněn k přístupu k daným datům.

• Implementujte bezpečné nouzové odpovědi: Nastavte logiku API tak, aby v případě neposkytnutí nebo neshody požadovaného ověření vracela obecné zprávy nebo chyby:

  • Příklad: „Údaje o objednávce se nepodařilo načíst. Ověřte prosím svůj e-mail a číslo objednávky.“

Používejte omezený rozsah dat v odpovědích API

• Minimalizujte expozici dat: Nakonfigurujte odpovědi API tak, aby obsahovaly pouze data nezbytná pro fungování chatbota, čímž snížíte riziko neúmyslného zobrazení citlivých informací.
  • Příklad: Místo vracení celých profilů uživatelů vracejte pouze konkrétní pole, jako je stav objednávky nebo potvrzení platby, která jsou vyžadována pro úkol daného chatbota.