Passa al contenuto principale

Rest API

Il collegamento Rest API consente di connettere qualsiasi API HTTP a Siesta AI senza la necessità di un connettore nativo speciale. All'interno di un'unica connessione, puoi definire più funzioni (endpoint) e impostare parametri per ciascuna funzione.

1. Aggiunta di una nuova connessione Rest API​

  1. Apri la sezione Connessioni.
  2. Clicca su Aggiungi Connessione.
  3. Nella finestra di dialogo, seleziona la tessera Rest API.

Selezione Rest API nella finestra di dialogo Aggiungi Connessione

2. Configurazione di base della connessione​

Dopo aver selezionato Rest API, compila:

  • Nome: nome dell'integrazione in Siesta AI.
  • Base URL: URL di base dell'API (ad es. https://api.example.com).
  • Visibilità: determina la disponibilità della connessione.
  • Privato = la connessione è visibile solo per te.
  • Condiviso = la connessione può essere utilizzata da più utenti nell'organizzazione.

Modulo di connessione Rest API e definizione della funzione

3. Funzioni (endpoint)​

Nella sezione Funzioni definisci le chiamate API specifiche:

  • Aggiungi funzione aggiunge un altro endpoint.
  • Nome della funzione: nome interno della funzione da utilizzare negli agenti/workflow.
  • Descrizione: breve descrizione di cosa fa l'endpoint.
  • Endpoint: combina il metodo HTTP (GET, POST, PUT, DELETE, ...) e il percorso dell'endpoint (ad es. /example), che si compone con la Base URL.

Praticamente significa che:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • chiamata risultante: https://api.example.com/orders

4. Parametri della funzione​

Nella sezione Parametri puoi aggiungere più parametri per ciascuna funzione tramite Aggiungi parametro.

Elementi configurabili:

  • Chiave: nome del parametro.
  • Tipo di valore: tipo di dato (ad es. String).
  • Posizione: dove viene scritto il parametro (Query, Path, Header, eventualmente Body a seconda dell'endpoint).
  • Obbligatorio: se il parametro è obbligatorio.
  • Descrizione: descrizione documentativa del parametro.
  • Valore statico: valore fisso opzionale che viene sempre inviato.

Definizione dei parametri della funzione nella connessione Rest API

5. Raccomandazioni per l'uso​

  • Utilizza una denominazione coerente delle funzioni in base all'azione di business (ad es. getOrders, createTicket).
  • Imposta i parametri obbligatori come Required = true, per evitare chiamate non valide.
  • Conserva in modo sicuro i valori sensibili e non passarli come testo libero nel prompt.
  • Per le connessioni condivise (Shared), controlla regolarmente chi ha accesso all'integrazione.

Il connettore Rest API è un modo universale per collegare sistemi esterni a Siesta AI tramite endpoint HTTP. Consente di combinare più funzioni in un'unica integrazione e di gestire dettagliatamente i parametri di ciascuna chiamata.