Skip to main content

Rest API

Rest API -liitäntä mahdollistaa minkä tahansa HTTP API:n liittämisen Siesta AI:hin ilman erityistä natiivia liitintä. Yhden liitännän puitteissa voit määrittää useita toimintoja (endpointteja) ja asettaa parametreja jokaiselle toiminnolle.

1. Uuden Rest API -liitännän lisääminen​

  1. Avaa Liitännät-osio.
  2. Napsauta Add Connection.
  3. Valitse dialogissa laatikko Rest API.

Valinta Rest API Add Connection -dialogissa

2. Liitännän peruskonfigurointi​

Rest API:n valinnan jälkeen täytä:

  • Name: integraation nimi Siesta AI:ssa.
  • Base URL: API:n perus-URL (esim. https://api.example.com).
  • Visibility: määrittää liitännän saatavuuden.
  • Private = liitäntä on näkyvissä vain sinulle.
  • Shared = liitännän voi käyttää useampi käyttäjä organisaatiossa.

Rest API -liitännän lomake ja toiminnon määrittely

3. Toiminnot (endpointit)​

Toiminnot-osiossa määrität tarkat API-kutsut:

  • Add function lisää toisen endpointin.
  • Function name: toiminnon sisäinen nimi, jota käytetään agenteissa/workflow:ssa.
  • Description: lyhyt kuvaus siitä, mitä endpoint tekee.
  • Endpoint: yhdistää HTTP-menetelmän (GET, POST, PUT, DELETE, ...) ja endpointin polun (esim. /example), joka koostuu Base URL:sta.

Käytännössä tämä tarkoittaa, että:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • tuloksena oleva kutsu: https://api.example.com/orders

4. Toiminnon parametrit​

Parameters-osiossa voit lisätä jokaiselle toiminnolle useita parametreja valitsemalla Add parameter.

Määritettävät kohteet:

  • Key: parametrin nimi.
  • Value type: tietotyyppi (esim. String).
  • Position: mihin parametri kirjoitetaan (Query, Path, Header, tai Body endpointin mukaan).
  • Required: onko parametri pakollinen.
  • Description: dokumentaatio kuvaus parametrista.
  • Static value: valinnainen kiinteä arvo, joka lähetetään aina.

Toiminnon parametrien määrittely Rest API -liitännässä

5. Käyttösuositukset​

  • Käytä johdonmukaista nimitystä toiminnoille liiketoimintatoiminnan mukaan (esim. getOrders, createTicket).
  • Aseta pakolliset parametrit Required = true, jotta vältetään virheelliset kutsut.
  • Tallenna arkaluontoiset arvot turvallisesti eikä lähetä niitä vapaana tekstinä kehotteessa.
  • Jaetuissa liitännöissä (Shared) tarkista jatkuvasti, kenellä on pääsy integraatioon.

Yhteenveto​

Rest API -liitin on universaali tapa liittää ulkoisia järjestelmiä Siesta AI:hin HTTP endpointtien kautta. Se mahdollistaa useiden toimintojen yhdistämisen yhteen integraatioon ja parametrien tarkemman hallinnan jokaisessa kutsussa.