Documentación en Desarrollo

Esta guía está actualmente en desarrollo. El contenido puede estar incompleto o sujeto a cambios.

~10 minutos

Integraciones de API

Conecta tus flujos a sistemas externos usando credenciales e integraciones de API. Aprende a configurar autenticacion y usar APIs en tus flujos de trabajo.

Entendiendo las Integraciones de API

Auralytik proporciona dos formas de conectarse a APIs externas:

Credenciales Simples

Configuracion rapida para necesidades basicas de autenticacion. Almacena claves API, tokens o combinaciones de usuario/contrasena.

Mejor para: APIs simples con autenticacion estatica

Integraciones Completas

Configuracion completa de API con multiples endpoints, autenticacion avanzada (OAuth2) y mapeo de respuestas.

Mejor para: APIs complejas con multiples endpoints

Consejo: Comienza con Credenciales Simples para integraciones rapidas. Usa Integraciones Completas cuando necesites multiples endpoints o funciones avanzadas.

Gestionando Credenciales de API

Almacena y gestiona credenciales de autenticacion de forma segura para tus conexiones de API.

Accediendo a Credenciales

  1. Navega a AI Integraciones desde la barra lateral
  2. Selecciona la pestana Credenciales
  3. Ve, crea o edita credenciales
Grilla de credenciales de API

Tipos de Autenticacion

API Key

Autenticacion por clave API basada en header. La clave se envia en un header especificado (ej., X-API-Key).

Bearer

Autenticacion basada en token usando el header Authorization con esquema Bearer.

Basic

Usuario y contrasena codificados en el header Authorization.

Query Params

Credenciales pasadas como parametros de query URL (para APIs que lo requieren).

Creando Credenciales

  1. Haz clic en "Agregar Credencial"
  2. Ingresa un nombre descriptivo (ej., "CRM Produccion API")
  3. Selecciona el tipo de autenticacion
  4. Ingresa los valores de credencial
  5. Haz clic en "Guardar"
Formulario de crear credencial

Seguridad

Todos los valores de credenciales se encriptan en reposo y nunca se exponen en logs o respuestas. Solo el nombre de la credencial es visible despues de la creacion.

Creando Integraciones de API

Las integraciones completas de API te permiten configurar multiples endpoints con funciones avanzadas.

Lista de integraciones de API

Creando una Integracion

  1. Navega a AI Integraciones → Integraciones
  2. Haz clic en "Crear Integracion"
  3. Ingresa detalles de la integracion:
    • Nombre (ej., "CRM de Clientes")
    • URL Base (ej., "https://api.crm.com/v1")
    • Headers por defecto
    • Metodo de autenticacion
  4. Agrega endpoints
  5. Guarda la integracion
Formulario de crear integracion

Configurando Endpoints

Cada integracion puede tener multiples endpoints:

Configuracion de endpoint

Captura de pantalla proximamente

Endpoint: Obtener Cliente
Metodo: GET
Ruta: /customers/{customerId}
Parametros:
  - customerId (ruta): Identificador del cliente

Endpoint: Actualizar Cliente
Metodo: PATCH
Ruta: /customers/{customerId}
Parametros:
  - customerId (ruta): Identificador del cliente
  - body (JSON): Payload de actúalizacion

Autenticacion Avanzada

Las integraciones completas soportan metodos de autenticacion avanzados:

OAuth2

Flujo de credenciales de cliente o codigo de autorizacion con renovacion automatica de token.

Challenge-Response

Autenticacion multi-paso con tokens dinamicos.

Referencias a Key Vault

Referenciar secretos almacenados en Azure Key Vault para seguridad empresarial.

Usando APIs en Flujos

Usa el paso LlamadaApi en tus flujos para interactúar con APIs externas.

Configuracion del Paso LlamadaApi

  1. Agrega un paso LlamadaApi a tu flujo
  2. Selecciona la integracion y endpoint
  3. Mapea variables del flujo a parametros de API
  4. Mapea campos de respuesta de API a variables del flujo

Mapeo de parametros/respuesta

Captura de pantalla proximamente

Mapeo de Parametros

Mapea datos de tu dataset o variables del flujo a parametros de API:

// Endpoint API: GET /customers/{customerId}
// Mapeo de parametros:
customerId → {{row.customer_id}}

// Endpoint API: POST /appointments
// Mapeo de body:
{
  "customer_id": "{{row.customer_id}}",
  "date": "{{extraido.fecha_preferida}}",
  "time": "{{extraido.hora_preferida}}",
  "notes": "{{clasificacion_ia}}"
}

Mapeo de Respuesta

Extrae datos de respuestas de API para usar en pasos subsiguientes:

// Respuesta API:
{
  "customer": {
    "name": "Juan Garcia",
    "balance": 150000,
    "status": "active"
  }
}

// Mapeo de respuesta:
nombre_cliente → response.customer.name
saldo_cliente → response.customer.balance
estado_cliente → response.customer.status

Manejo de Errores

Configura como manejar errores de API:

  • Continuar: Proceder con el flujo aunque la API falle
  • Reintentar: Reintentar la solicitud con backoff
  • Fallar: Marcar la fila como fallida
  • Ramificar: Dirigir a una rama de manejo de errores

Usando APIs en Acciones de Voz

Realiza llamadas API en tiempo real durante conversaciones de voz para proporcionar informacion dinamica.

Configurando Acciones de Voz con API

  1. En tu paso LlamadaVoz, ve a Acciones
  2. Agrega una accion LlamadaApi
  3. Selecciona la integracion y endpoint
  4. Define parametros que la IA debe recopilar del llamante
  5. Configura la plantilla de respuesta para que la IA la hable

Ejemplo de API en Tiempo Real

// Accion: verificar_saldo
// Descripcion: Consultar saldo de cuenta del cliente
// Parametros:
//   - numero_cuenta: Numero de cuenta del cliente

// IA durante la llamada:
"Por favor indiqueme su numero de cuenta"
[Cliente: "1234567"]
// IA dispara llamada API con numero_cuenta=1234567

// Plantilla de respuesta:
"Su saldo actúal es {{response.balance}} pesos.
 Su proximo pago de {{response.next_payment}} vence el
 {{response.due_date}}."

Consejo de Rendimiento: Manten las llamadas API rapidas (bajo 2 segundos) para mantener un flujo de conversación natural. Cachea datos frecuentemente accedidos cuando sea posible.

Aprende Mas

Para detalles completos sobre configuracion de acciones de voz:Guia de Acciones de Voz →