Niestandardowe akcje API

Niestandardowe akcje API pozwalają agentowi wywołać zewnętrzny punkt końcowy HTTP podczas rozmowy i użyć odpowiedzi do udzielenia odpowiedzi odwiedzającemu. Używaj tego do sprawdzania statusu zamówienia, sprawdzania dostępności, pobierania szczegółów konta lub odpytywania dowolnego wewnętrznego API.

Utwórz akcję

Przejdź do Możliwości → Niestandardowe akcje API i kliknij Dodaj akcję.

Ustawienia ogólne

• Nazwa — jak AI wewnętrznie nazywa tę akcję. Niech będzie krótka i opisowa: Sprawdź status zamówienia, Pobierz dostępność produktu.
• Kiedy używać — opis w naturalnym języku, kiedy AI powinna wyzwolić tę akcję.

Użyj tej akcji, gdy odwiedzający pyta o status swojego zamówienia lub chce śledzić przesyłkę.

Skonfiguruj wywołanie API

Metoda i URL

Wybierz metodę HTTP (GET, POST, PUT, PATCH, DELETE) i wprowadź URL punktu końcowego. Używaj {{zmiennych}} dla wartości dynamicznych:

https://api.twojsklep.com/orders/{{order_id}}

Dane wejściowe

Zdefiniuj zmienne potrzebne w URL, nagłówkach lub treści. Dla każdego wejścia:

Przykład dla wyszukiwania zamówienia:

• Nazwa: order_id · Opis: Numer zamówienia podany przez odwiedzającego · Wymagane: tak

AI automatycznie wyodrębnia wartości z kontekstu rozmowy. Jeśli brakuje wymaganej wartości, AI poprosi odwiedzającego o jej podanie przed wykonaniem wywołania.

Nagłówki, parametry, treść

Użyj zakładek, aby dodać nagłówki autoryzacji, parametry zapytania lub treść żądania. Zmienne działają wszędzie:

Authorization: Bearer {{api_token}}

W przypadku statycznych sekretów (takich jak tokeny API), których nie chcesz wyodrębniać z czatu, wpisz je bezpośrednio jako wartości bez zmiennej — nie będą udostępniane AI ani odwiedzającym.

Przetestuj akcję

W sekcji Testuj odpowiedź wprowadź przykładowe wartości dla swoich danych wejściowych i kliknij Uruchom test. Zostanie wykonane rzeczywiste wywołanie HTTP i wyświetlona odpowiedź. Użyj tego, aby zweryfikować poprawność URL i uwierzytelniania przed uruchomieniem na produkcji.

Dostęp do danych

Kontroluje, które części odpowiedzi API może zobaczyć AI:

• Pełny — cała odpowiedź JSON jest przekazywana do AI. Używaj dla prostych odpowiedzi, gdzie potrzebne są wszystkie pola.
• Ograniczony — do AI przekazywane są tylko pola z białej listy. Używaj tego, aby chronić wrażliwe dane (wewnętrzne identyfikatory, tokeny, dane osobowe) przed uwzględnieniem ich w odpowiedziach AI.

Wprowadź ścieżki pól, po jednej w wierszu, używając notacji z kropką:

order.status
order.estimated_delivery
customer.name

Wskazówki

• Utrzymuj zwięzłe odpowiedzi — AI podsumowuje odpowiedź przy udzielaniu odpowiedzi, więc skoncentrowana odpowiedź daje lepsze wyniki niż obiekt z 200 polami.
• Używaj Ograniczonego dostępu do danych dla każdego API zwracającego wrażliwe pola obok tych, których potrzebujesz.
• Jeśli Twoje API wymaga OAuth, użyj długotrwałego tokena serwisowego zamiast tokena użytkownika — akcja działa na serwerze BotChata, nie w przeglądarce odwiedzającego.
• Składnia {{zmienna}} działa w: ścieżce URL, parametrach zapytania, nagłówkach i treści żądania.