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: xia_assistants
  • Llamadas: xia_calls
  • Teléfonos: xia_phone_numbers

URL de la API

La URL base para acceder a la API de pruebas es:

https://tudominio.xfs.cloud/xapi.php/v1 (La Url final Corresponde al dominio seleccionado)

Autenticación

Para autenticarte en la API, debes agregar el token suministrado en el "Header" de tu solicitud.

Utiliza una variable llamada Token.

Ejemplo en Header:


Token: TU_TOKEN_SUMINISTRADO
                    

Puedes probar esto fácilmente con herramientas como Postman, usando "API Key" como "Auth Type", "Token" como "Key", tu token como "Value" y seleccionando "Header" en "Add to".

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.