Zum Hauptinhalt springen

Rest API

Die Rest API-Verbindung ermöglicht es, beliebige HTTP-APIs in Siesta AI zu integrieren, ohne dass ein spezieller nativer Connector erforderlich ist. Innerhalb einer Verbindung können Sie mehrere Funktionen (Endpoints) definieren und für jede Funktion Parameter festlegen.

1. Hinzufügen einer neuen Rest API-Verbindung​

  1. Öffnen Sie den Abschnitt Verbindungen.
  2. Klicken Sie auf Verbindung hinzufügen.
  3. Wählen Sie im Dialogfeld die Kachel Rest API aus.

Auswahl von Rest API im Dialogfeld Verbindung hinzufügen

2. Grundkonfiguration der Verbindung​

Nach der Auswahl von Rest API füllen Sie aus:

  • Name: Name der Integration in Siesta AI.
  • Basis-URL: Basis-URL der API (z. B. https://api.example.com).
  • Sichtbarkeit: bestimmt die Verfügbarkeit der Verbindung.
  • Privat = die Verbindung ist nur für Sie sichtbar.
  • Geteilt = die Verbindung kann von mehreren Benutzern in der Organisation verwendet werden.

Formular für Rest API-Verbindung und Funktionsdefinition

3. Funktionen (Endpoints)​

Im Abschnitt Funktionen definieren Sie die spezifischen API-Aufrufe:

  • Funktion hinzufügen fügt einen weiteren Endpoint hinzu.
  • Funktionsname: interner Name der Funktion zur Verwendung in Agenten/Workflows.
  • Beschreibung: kurze Beschreibung, was der Endpoint macht.
  • Endpoint: kombiniert die HTTP-Methode (GET, POST, PUT, DELETE, ...) und den Pfad des Endpoints (z. B. /example), der sich aus der Basis-URL zusammensetzt.

Praktisch bedeutet das:

  • Basis-URL: https://api.example.com
  • Endpoint: /orders
  • das resultierende Aufruf: https://api.example.com/orders

4. Parameter der Funktion​

Im Abschnitt Parameter können Sie für jede Funktion mehrere Parameter über Parameter hinzufügen hinzufügen.

Einstellbare Elemente:

  • Schlüssel: Name des Parameters.
  • Werttyp: Datentyp (z. B. String).
  • Position: wo der Parameter geschrieben wird (Query, Path, Header, eventuell Body je nach Endpoint).
  • Erforderlich: ob der Parameter erforderlich ist.
  • Beschreibung: dokumentarische Beschreibung des Parameters.
  • Statischer Wert: optionale feste Wert, der immer gesendet wird.

Definition der Parameter der Funktion in der Rest API-Verbindung

5. Empfehlungen zur Verwendung​

  • Verwenden Sie konsistente Benennungen für Funktionen entsprechend der Geschäftshandlung (z. B. getOrders, createTicket).
  • Setzen Sie erforderliche Parameter auf Erforderlich = true, um ungültige Aufrufe zu vermeiden.
  • Speichern Sie sensible Werte sicher und übermitteln Sie sie nicht als freien Text im Prompt.
  • Überprüfen Sie bei geteilten Verbindungen (Geteilt) regelmäßig, wer Zugriff auf die Integration hat.

Zusammenfassung​

Der Rest API-Connector ist eine universelle Möglichkeit, externe Systeme über HTTP-Endpoints in Siesta AI zu integrieren. Er ermöglicht es, mehrere Funktionen in einer einzigen Integration zu kombinieren und die Parameter jedes Aufrufs detailliert zu steuern.