Dashboard Página principal de la documentación API

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: Para gestionar los asistentes de IA.
  • Llamadas: Para consultar el registro de llamadas.
  • Teléfonos: Para listar y asignar números telefónicos.
  • Facturación: Para consultar saldo y transacciones.
  • Herramientas: Utilidades de fechas y horas.
  • Credenciales: Para obtener credenciales de la API vía token.

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.