Hop til hovedindhold

Rest API

Rest API-forbindelsen gør det muligt at tilslutte enhver HTTP API til Siesta AI uden behov for en speciel native connector. Inden for én forbindelse kan du definere flere funktioner (endpoints) og indstille parametre for hver funktion.

1. Tilføjelse af en ny Rest API-forbindelse​

  1. Åbn sektionen Forbindelser.
  2. Klik på Add Connection.
  3. Vælg flisen Rest API i dialogboksen.

Valg af Rest API i Add Connection-dialogen

2. Grundlæggende konfiguration af forbindelsen​

Efter valg af Rest API skal du udfylde:

  • Name: navnet på integrationen i Siesta AI.
  • Base URL: grundlæggende URL for API'et (f.eks. https://api.example.com).
  • Visibility: angiver tilgængeligheden af forbindelsen.
  • Private = forbindelsen er kun synlig for dig.
  • Shared = forbindelsen kan bruges af flere brugere i organisationen.

Formular for Rest API-forbindelse og funktionsdefinition

3. Funktioner (endpoints)​

I sektionen Functions definerer du specifikke API-opkald:

  • Add function tilføjer en anden endpoint.
  • Function name: intern navn på funktionen til brug i agenter/workflows.
  • Description: kort beskrivelse af, hvad endpointet gør.
  • Endpoint: kombinerer HTTP-metoden (GET, POST, PUT, DELETE, ...) og stien til endpointet (f.eks. /example), som er sammensat med Base URL.

Praktisk betyder det, at:

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

4. Funktionsparametre​

I sektionen Parameters kan du tilføje flere parametre for hver funktion via Add parameter.

Indstillingsmuligheder:

  • Key: navnet på parameteren.
  • Value type: datatypen (f.eks. String).
  • Position: hvor parameteren skrives (Query, Path, Header, eventuelt Body afhængigt af endpointet).
  • Required: om parameteren er obligatorisk.
  • Description: dokumentationsbeskrivelse af parameteren.
  • Static value: valgfri fast værdi, der altid sendes.

Definition af funktionsparametre i Rest API-forbindelsen

5. Anbefalinger til brug​

  • Brug konsekvent navngivning af funktioner baseret på forretningshandlinger (f.eks. getOrders, createTicket).
  • Indstil obligatoriske parametre som Required = true for at undgå ugyldige opkald.
  • Opbevar følsomme værdier sikkert og send dem ikke som frit tekst i prompten.
  • For delte forbindelser (Shared) skal du løbende kontrollere, hvem der har adgang til integrationen.

Resumé​

Rest API-connectoren er en universel måde at tilslutte eksterne systemer til Siesta AI via HTTP-endpoints. Den muliggør kombination af flere funktioner i én integration og detaljeret styring af parametrene for hvert opkald.