Documentación General de la API de X-IAnet
Bienvenido a la documentación de la API de X-IAnet. Aquí encontrarás información sobre los endpoints disponibles y cómo interactuar con ellos.
Listado de Endpoints
La API de X-IAnet cuenta con los siguientes endpoints (controladores de API):
- Asistentes: Gestión de asistentes de IA, actualización flexible (
POSTyPATCH), vinculación de herramientas (toolIds) y archivos de conocimiento (fileIds). - Teléfonos y Consumos: Listado de números asignados, métricas acumuladas, consumos mensuales calculados con detalle individual de llamadas y consulta por número específico (
number-consumption). - Llamadas: Consulta de historiales, llamadas por asistente y generación de llamadas salientes.
- Facturación: Consulta de saldo disponible y transacciones de recargas y consumos.
- Herramientas (Tools) y Squads: Creación y vinculación de herramientas personalizadas, utilidades de fecha/hora y configuración de equipos de asistentes.
- Archivos: Carga y gestión de archivos (
.txt/.csv) para la Base de Conocimiento de los asistentes. - Credenciales: Consulta de credenciales de la API mediante token privado.
URL de la API
La URL base para acceder a la API de pruebas es:
https://app.x-ianet.com/api/xianet
Autenticación
Para autenticarte en la API, debes proveer tu Usuario API y Key API en los encabezados (Headers) de tu solicitud.
Utiliza las variables ApiUser y ApiKey.
Ejemplo en Headers:
ApiUser: TU_USUARIO_API
ApiKey: TU_API_KEY
Puedes probar esto fácilmente con herramientas como Postman, agregando ApiUser y
ApiKey en la pestaña "Headers".
Envío de Parámetros (PUT, POST, PATCH)
En el caso de solicitudes que modifican datos (PUT, POST o PATCH),
los parámetros deben enviarse en el "body" de la solicitud.
El formato esperado es JSON.
Ejemplo de Body (JSON Raw):
{
"parametro1": "valor1",
"parametro2": "valor2"
// ... otros parámetros
}
Puedes probar esto generando un JSON en modo "raw" en herramientas como Postman.