Skip to main content

Rest API

Rest API pripojenie umožňuje napojiť ľubovoľné HTTP API do Siesta AI bez potreby špeciálneho natívneho konektora. V rámci jedného pripojenia môžete definovať viac funkcií (endpointov) a pre každú funkciu nastaviť parametre.

1. Pridanie nového Rest API pripojenia​

  1. Otvorte sekciu Pripojenia.
  2. Kliknite na Add Connection.
  3. V dialógu vyberte dlaždicu Rest API.

Výber Rest API v Add Connection dialógu

2. Základná konfigurácia pripojenia​

Po výbere Rest API vyplňte:

  • Name: názov integrácie v Siesta AI.
  • Base URL: základná URL API (napr. https://api.example.com).
  • Visibility: určuje dostupnosť pripojenia.
  • Private = pripojenie je viditeľné iba pre vás.
  • Shared = pripojenie môže používať viac používateľov v organizácii.

Formulár Rest API pripojenia a definícia funkcie

3. Funkcie (endpointy)​

V časti Functions definujete konkrétne volania API:

  • Add function pridá ďalší endpoint.
  • Function name: interný názov funkcie na použitie v agentoch/workflow.
  • Description: stručný popis, čo endpoint robí.
  • Endpoint: kombinuje HTTP metódu (GET, POST, PUT, DELETE, ...) a cestu endpointu (napr. /example), ktorá sa skladá s Base URL.

Prakticky to znamená, že:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • výsledné volanie: https://api.example.com/orders

4. Parametre funkcie​

V časti Parameters môžete pre každú funkciu pridať viac parametrov cez Add parameter.

Nastaviteľné položky:

  • Key: názov parametra.
  • Value type: dátový typ (napr. String).
  • Position: kam sa parameter zapisuje (Query, Path, Header, prípadne Body podľa endpointu).
  • Required: či je parameter povinný.
  • Description: dokumentačný popis parametra.
  • Static value: voliteľná pevná hodnota, ktorá sa posiela vždy.

Definícia parametrov funkcie v Rest API pripojení

5. Odporúčania na použitie​

  • Používajte konzistentné pomenovanie funkcií podľa business akcie (napr. getOrders, createTicket).
  • Povinné parametre nastavujte ako Required = true, aby sa predišlo nevalidným volaniam.
  • Citlivé hodnoty ukladajte bezpečne a nepodávajte ich ako voľný text v promptu.
  • U zdieľaných pripojení (Shared) priebežne kontrolujte, kto má k integrácii prístup.

Zhrnutie​

Rest API konektor je univerzálny spôsob, ako do Siesta AI pripojiť externé systémy cez HTTP endpointy. Umožňuje kombinovať viac funkcií v jednej integrácii a detailne riadiť parametre každého volania.