Hoppa till huvudinnehåll

Rest API

Rest API-anslutningen gör det möjligt att koppla valfritt HTTP API till Siesta AI utan behov av en speciell inbyggd anslutning. Inom en anslutning kan du definiera flera funktioner (endpoints) och för varje funktion ställa in parametrar.

1. Lägga till en ny Rest API-anslutning​

  1. Öppna sektionen Anslutningar.
  2. Klicka på Add Connection.
  3. I dialogrutan väljer du rutan Rest API.

Val av Rest API i Add Connection-dialogrutan

2. Grundläggande konfiguration av anslutningen​

Efter att ha valt Rest API fyller du i:

  • Name: namnet på integrationen i Siesta AI.
  • Base URL: grundläggande URL för API:et (t.ex. https://api.example.com).
  • Visibility: anger tillgängligheten för anslutningen.
  • Private = anslutningen är synlig endast för dig.
  • Shared = anslutningen kan användas av flera användare inom organisationen.

Formulär för Rest API-anslutning och funktionsdefinition

3. Funktioner (endpoints)​

I avsnittet Functions definierar du specifika API-anrop:

  • Add function lägger till en annan endpoint.
  • Function name: internt namn på funktionen för användning i agenter/workflows.
  • Description: en kort beskrivning av vad endpointen gör.
  • Endpoint: kombinerar HTTP-metoden (GET, POST, PUT, DELETE, ...) och sökvägen till endpointen (t.ex. /example), som består av Base URL.

Praktiskt betyder det att:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • det resulterande anropet: https://api.example.com/orders

4. Funktionsparametrar​

I avsnittet Parameters kan du för varje funktion lägga till flera parametrar via Add parameter.

Inställningsbara objekt:

  • Key: namnet på parametern.
  • Value type: datatyp (t.ex. String).
  • Position: var parametern skrivs ( Query, Path, Header, eller Body beroende på endpointen).
  • Required: om parametern är obligatorisk.
  • Description: dokumentationsbeskrivning av parametern.
  • Static value: valfritt fast värde som alltid skickas.

Definition av funktionsparametrar i Rest API-anslutningen

5. Rekommendationer för användning​

  • Använd konsekvent namngivning av funktioner baserat på affärshandlingar (t.ex. getOrders, createTicket).
  • Ställ in obligatoriska parametrar som Required = true för att undvika ogiltiga anrop.
  • Spara känsliga värden säkert och överför dem inte som vanlig text i prompten.
  • För delade anslutningar (Shared) kontrollera regelbundet vem som har tillgång till integrationen.

Sammanfattning​

Rest API-anslutningen är ett universellt sätt att koppla externa system till Siesta AI via HTTP-endpoints. Den möjliggör kombination av flera funktioner i en integration och detaljerad hantering av parametrarna för varje anrop.