Saltar al contenido principal

Rest API

La conexión de Rest API permite conectar cualquier API HTTP a Siesta AI sin necesidad de un conector nativo especial. Dentro de una sola conexión, puedes definir múltiples funciones (endpoints) y establecer parámetros para cada función.

1. Añadir una nueva conexión de Rest API​

  1. Abre la sección Conexiones.
  2. Haz clic en Add Connection.
  3. En el diálogo, selecciona la opción Rest API.

Selección de Rest API en el diálogo de Add Connection

2. Configuración básica de la conexión​

Después de seleccionar Rest API, completa:

  • Name: el nombre de la integración en Siesta AI.
  • Base URL: la URL base de la API (por ejemplo, https://api.example.com).
  • Visibility: determina la disponibilidad de la conexión.
  • Private = la conexión es visible solo para ti.
  • Shared = la conexión puede ser utilizada por varios usuarios en la organización.

Formulario de conexión de Rest API y definición de función

3. Funciones (endpoints)​

En la sección Functions defines las llamadas específicas a la API:

  • Add function añade otro endpoint.
  • Function name: nombre interno de la función para uso en agentes/workflows.
  • Description: breve descripción de lo que hace el endpoint.
  • Endpoint: combina el método HTTP (GET, POST, PUT, DELETE, ...) y la ruta del endpoint (por ejemplo, /example), que se compone con la Base URL.

Prácticamente significa que:

  • Base URL: https://api.example.com
  • Endpoint: /orders
  • llamada resultante: https://api.example.com/orders

4. Parámetros de la función​

En la sección Parameters puedes añadir más parámetros para cada función a través de Add parameter.

Elementos configurables:

  • Key: nombre del parámetro.
  • Value type: tipo de dato (por ejemplo, String).
  • Position: dónde se escribe el parámetro (Query, Path, Header, o Body según el endpoint).
  • Required: si el parámetro es obligatorio.
  • Description: descripción documental del parámetro.
  • Static value: valor fijo opcional que se envía siempre.

Definición de parámetros de función en la conexión de Rest API

5. Recomendaciones para el uso​

  • Utiliza una nomenclatura consistente para las funciones según la acción de negocio (por ejemplo, getOrders, createTicket).
  • Establece los parámetros obligatorios como Required = true para evitar llamadas no válidas.
  • Almacena valores sensibles de forma segura y no los transmitas como texto libre en el prompt.
  • En conexiones compartidas (Shared), verifica continuamente quién tiene acceso a la integración.

Resumen​

El conector de Rest API es una forma universal de conectar sistemas externos a Siesta AI a través de endpoints HTTP. Permite combinar múltiples funciones en una sola integración y gestionar detalladamente los parámetros de cada llamada.