Skip to main content

Descripción del módulo

La API Pública de Airvi permite consultar información registrada en el sistema (clientes, reservas, pagos y reembolsos) desde sistemas externos o integraciones de terceros.
Este módulo está diseñado para ofrecer acceso seguro, controlado y auditable a los datos del sistema sin necesidad de acceso directo a la base de datos.

Cada consulta genera un identificador único de rastreo (trace_id), útil para seguimiento de errores o solicitudes de soporte.
El acceso se gestiona mediante claves (tokens) que se generan desde el panel administrativo de Airvi.

Acceso al módulo

  1. Ingrese a su cuenta de Airvi con un usuario con permisos administrativos.

  2. Diríjase a la sección Parametrización → Claves (API Pública).

  3. Active la casilla “Generar nuevo token de autenticación”.

  4. Haga clic en “Generar claves”.

  5. Copie el token generado.

⚠️ Importante:
Guarde este token en un lugar seguro. Es necesario incluirlo en el encabezado de cada solicitud a la API.
Ejemplo de encabezado:


Authorization: Bearer {TOKEN}

Acceso a la documentación técnica

  1. Abra el navegador e ingrese la siguiente dirección:


    {BASE_URL}/docs/api

  2. En esta interfaz podrá visualizar los diferentes endpoints disponibles, sus parámetros, ejemplos de uso y respuestas esperadas.

  3. Puede ejecutar peticiones directamente desde el navegador, siempre que haya autenticado con su token.

📝 Nota:
La ruta incluye un guion medio entre “docs” y “api”. Es decir: docs-api, no “docsapi”.

Autenticación y seguridad

Todas las consultas se realizan mediante un token de autenticación generado desde Airvi. El token se envía en el encabezado HTTP de la petición.

Ejemplo de encabezado:

Authorization: Bearer 1234abcd5678efgh

 

Estructura de las respuestas

Cada respuesta de la API tiene una estructura estándar:

{
  "status": "success",
  "errors": [],
  "data": {
    "items": [],
    "total": 0
  },
  "trace_id": "01J9ZP..."
}

  • status: indica si la consulta fue exitosa (success) o falló (fail).

  • errors: lista de errores o validaciones.

  • data.items: contiene la información solicitada.

  • trace_id: identificador único para auditoría y soporte técnico.

💡 Consejo:
Si una consulta falla o devuelve resultados vacíos, conserve el trace_id y compártalo con el área de soporte para una revisión más rápida.

Back to top