Skip to main content

Rest API

Rest API-tilkoblingen gjør det mulig å koble et hvilket som helst HTTP API til Siesta AI uten behov for en spesialtilpasset, innfødt tilkobling. Innenfor én tilkobling kan du definere flere funksjoner (endepunkter) og for hver funksjon sette parametere.

1. Legge til en ny Rest API-tilkobling​

  1. Åpne seksjonen Tilkoblinger.
  2. Klikk på Add Connection.
  3. I dialogvinduet velger du flisen Rest API.

Valg av Rest API i Add Connection-dialogen

2. Grunnleggende konfigurasjon av tilkoblingen​

Etter å ha valgt Rest API, fyll ut:

  • Name: navnet på integrasjonen i Siesta AI.
  • Base URL: grunnleggende URL for API-et (f.eks. https://api.example.com).
  • Visibility: angir tilgjengeligheten av tilkoblingen.
  • Private = tilkoblingen er synlig kun for deg.
  • Shared = tilkoblingen kan brukes av flere brukere i organisasjonen.

Skjema for Rest API-tilkobling og definisjon av funksjon

3. Funksjoner (endepunkter)​

I delen Functions definerer du spesifikke API-kall:

  • Add function legger til et annet endepunkt.
  • Function name: intern navn på funksjonen for bruk i agenter/workflow.
  • Description: kort beskrivelse av hva endepunktet gjør.
  • Endpoint: kombinerer HTTP-metoden (GET, POST, PUT, DELETE, ...) og stien til endepunktet (f.eks. /example), som består av Base URL.

Praktisk betyr dette at:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • det resulterende kallet: https://api.example.com/orders

4. Funksjonsparametere​

I delen Parameters kan du legge til flere parametere for hver funksjon via Add parameter.

Konfigurerbare elementer:

  • Key: navnet på parameteren.
  • Value type: datatypen (f.eks. String).
  • Position: hvor parameteren skrives (Query, Path, Header, eventuelt Body avhengig av endepunktet).
  • Required: om parameteren er obligatorisk.
  • Description: dokumentasjonsbeskrivelse av parameteren.
  • Static value: valgfri fast verdi som alltid sendes.

Definisjon av funksjonsparametere i Rest API-tilkoblingen

5. Anbefalinger for bruk​

  • Bruk konsistent navngivning av funksjoner i henhold til forretningshandling (f.eks. getOrders, createTicket).
  • Sett obligatoriske parametere som Required = true for å unngå ugyldige kall.
  • Oppbevar sensitive verdier sikkert og ikke send dem som fri tekst i prompten.
  • For delte tilkoblinger (Shared), kontroller jevnlig hvem som har tilgang til integrasjonen.

Oppsummering​

Rest API-kontakten er en universell måte å koble eksterne systemer til Siesta AI via HTTP-endepunkter. Den gjør det mulig å kombinere flere funksjoner i én integrasjon og detaljstyre parametrene for hvert kall.