Aller au contenu principal

API Rest

La connexion API Rest permet de connecter n'importe quelle API HTTP à Siesta AI sans avoir besoin d'un connecteur natif spécifique. Dans le cadre d'une seule connexion, vous pouvez définir plusieurs fonctions (endpoints) et configurer des paramètres pour chaque fonction.

1. Ajout d'une nouvelle connexion API Rest​

  1. Ouvrez la section Connexions.
  2. Cliquez sur Ajouter une connexion.
  3. Dans la boîte de dialogue, sélectionnez la tuile API Rest.

Sélection de l'API Rest dans la boîte de dialogue Ajouter une connexion

2. Configuration de base de la connexion​

Après avoir sélectionné l'API Rest, remplissez :

  • Nom : le nom de l'intégration dans Siesta AI.
  • URL de base : l'URL de base de l'API (par exemple, https://api.example.com).
  • Visibilité : détermine la disponibilité de la connexion.
  • Privé = la connexion est visible uniquement pour vous.
  • Partagé = la connexion peut être utilisée par plusieurs utilisateurs dans l'organisation.

Formulaire de connexion API Rest et définition de fonction

3. Fonctions (endpoints)​

Dans la section Fonctions, vous définissez les appels API spécifiques :

  • Ajouter une fonction ajoute un autre endpoint.
  • Nom de la fonction : nom interne de la fonction à utiliser dans les agents/workflows.
  • Description : brève description de ce que fait l'endpoint.
  • Endpoint : combine la méthode HTTP (GET, POST, PUT, DELETE, ...) et le chemin de l'endpoint (par exemple, /example), qui se compose de l'URL de base.

Cela signifie pratiquement que :

  • URL de base : https://api.example.com
  • Endpoint : /orders
  • appel résultant : https://api.example.com/orders

4. Paramètres de la fonction​

Dans la section Paramètres, vous pouvez ajouter plusieurs paramètres pour chaque fonction via Ajouter un paramètre.

Éléments configurables :

  • Clé : nom du paramètre.
  • Type de valeur : type de données (par exemple, String).
  • Position : où le paramètre est écrit (Query, Path, Header, éventuellement Body selon l'endpoint).
  • Requis : si le paramètre est obligatoire.
  • Description : description documentaire du paramètre.
  • Valeur statique : valeur fixe optionnelle qui est toujours envoyée.

Définition des paramètres de la fonction dans la connexion API Rest

5. Recommandations pour l'utilisation​

  • Utilisez une nomenclature cohérente des fonctions selon l'action commerciale (par exemple, getOrders, createTicket).
  • Configurez les paramètres obligatoires comme Requis = true pour éviter les appels non valides.
  • Stockez les valeurs sensibles en toute sécurité et ne les transmettez pas en texte libre dans le prompt.
  • Pour les connexions partagées (Partagé), vérifiez régulièrement qui a accès à l'intégration.

Résumé​

Le connecteur API Rest est un moyen universel de connecter des systèmes externes à Siesta AI via des endpoints HTTP. Il permet de combiner plusieurs fonctions dans une seule intégration et de gérer en détail les paramètres de chaque appel.