Rest API

Připojení Rest API vám umožňuje připojit jakékoli HTTP API k Siesta AI bez potřeby speciálního nativního připojení. V rámci jednoho připojení můžete definovat více funkcí (endpointů) a nastavit parametry pro každou funkci.

Tato stránka popisuje odchozí integraci: Siesta AI volá externí HTTP API. Pokud chcete, aby váš vlastní systém volal Siesta AI, použijte REST API.

1. Přidání nového připojení Rest API

1. Otevřete sekci Připojení.
2. Klikněte na Přidat připojení.
3. V dialogu vyberte dlaždici Rest API.

2. Základní konfigurace připojení

Po výběru Rest API vyplňte:

• Název: název integrace v Siesta AI.
• Základní URL: základní URL API (např. https://api.example.com).
• Viditelnost: určuje dostupnost připojení.
• Soukromé = připojení je viditelné pouze pro vás.
• Sdílené = připojení může být použito více uživateli v organizaci.

3. Funkce (Endpointy)

V sekci Funkce definujete konkrétní API volání:

• Přidat funkci přidá další endpoint.
• Název funkce: interní název funkce pro použití v agentech/workflow.
• Popis: stručný popis toho, co endpoint dělá.
• Endpoint: kombinuje HTTP metodu (GET, POST, PUT, DELETE, ...) a cestu endpointu (např. /example), která je složena se Základní URL.

Prakticky to znamená, že:

• Základní URL: https://api.example.com
• Endpoint: /orders
• výsledné volání: https://api.example.com/orders

4. Parametry funkce

V sekci Parametry můžete přidat více parametrů pro každou funkci pomocí Přidat parametr.

Konfigurovatelné položky:

• Klíč: název parametru.
• Typ hodnoty: datový typ (např. String).
• Pozice: kde je parametr zapsán (Query, Path, Header, nebo Body v závislosti na endpointu).
• Povinné: zda je parametr povinný.
• Popis: dokumentační popis parametru.
• Statická hodnota: volitelná pevná hodnota, která je vždy odeslána.

5. Doporučení pro použití

• Používejte konzistentní pojmenování funkcí podle obchodních akcí (např. getOrders, createTicket).
• Nastavte povinné parametry jako Povinné = true, abyste se vyhnuli neplatným voláním.
• Ukládejte citlivé hodnoty bezpečně a nepředávejte je jako prostý text v promptu.
• Pro sdílená připojení (Sdílené) pravidelně kontrolujte, kdo má přístup k integraci.

Shrnutí

Připojení Rest API je univerzální způsob, jak připojit externí systémy k Siesta AI prostřednictvím HTTP endpointů. Umožňuje kombinovat více funkcí v jedné integraci a podrobně spravovat parametry každého volání.

Technické poznámky

• Implementace: vlastní REST/API nástroje jsou definovány z konfigurace endpointu spíše než z pevného modulu připojení.
• Autentizace/rozsahy: závisí na konfigurovaném API: API klíč, bearer token, OAuth, základní autentizace nebo vlastní hlavičky. Omezte přihlašovací údaje na endpointy a prostředí, které agent skutečně potřebuje.
• Funkce: každá vystavená funkce mapuje na HTTP metodu, cestu, parametry, hlavičky a volitelné tělo požadavku definované administrátorem/vývojářem.
• Chování zápisu: endpointy POST, PUT, PATCH a DELETE mohou měnit externí systémy. Používejte potvrzení, staging endpointy a úzké seznamy povolení pro produkční agenty.