Módulo de Clientes
El módulo de Clientes permite acceder a la información registrada de los clientes del sistema, ya sea de forma general (listado) o específica (por ID o por documento).
Consultar listado de clientes
Función: obtener una lista paginada de clientes con sus datos básicos.
Ruta: https://{Base_URL}/api/public/v1/clients
Parámetros disponibles:
| Parámetro | Descripción |
|---|---|
take |
Cantidad de registros a retornar (obligatorio). |
skip |
Cantidad de registros a omitir. |
birthday_from y birthday_to |
Rango de fechas de nacimiento (opcional). |
ids[] |
Lista de identificadores específicos (opcional). |
Pasos para ejecutar la consulta:
-
Ingrese a
{BASE_URL}/docs/api. -
Busque la sección Clientes → Obtiene un listado paginado de clientes con sus datos básicos
-
En el campo
take, escriba la cantidad de registros que desea obtener (por ejemplo,10). -
Si desea filtrar, puede agregar
birthday_fromybirthday_toen formatoYYYY-MM-DD. -
Pulse “Enviar petición”.
-
Verifique la respuesta.
Si todo está correcto, obtendrá un código 200 OK con los datos solicitados.
Ejemplo de respuesta:
Consultar cliente por ID
Función: obtener los datos completos de un cliente específico usando su identificador.
Ruta: https://{Base_URL}/api/public/v1/clients/{id}
Pasos:
-
En el campo de la ruta, reemplace
{id}por el número de identificación del cliente (por ejemplo,2200). -
Agregue el parámetro
take=1. -
Envíe la petición.
-
Si el cliente existe, recibirá un código 200 OK.
-
Si el cliente no existe, obtendrá un 404 Not Found.
Ejemplo de solicitud:
Ejemplo de respuesta:
Consultar cliente por documento
Función: buscar un cliente utilizando su número de documento.
Ruta: GET {BASE_URL}/api/public_api/clients/by_identification/{document}
Pasos:
-
Sustituya
{document}por el número del documento (por ejemplo,103968949). -
Presione “Enviar petición”.
-
Verifique el código de estado:
-
200 OK: el cliente fue encontrado.
-
404 Not Found: no existe ningún cliente con ese documento.
-
Módulo de Reservas
El módulo de Reservas devuelve las reservas asociadas a cada cliente, filtradas por su identificador o por su documento.
💡 Nota:
Actualmente, las consultas devuelven únicamente las reservas del cliente titular.
Si desea incluir pasajeros no titulares, consulte con el equipo técnico de Airvi si esta opción está habilitada en su instancia.
Consultar reservas por ID de cliente
Ruta: GET {BASE_URL}/api/public_api/clients/{id}/reservations
Parámetros disponibles:
| Parámetro | Descripción |
|---|---|
assignment_date_from, assignment_date_to |
Fecha de asignación del viaje. |
trip_date_from, trip_date_to |
Fecha del viaje. |
skip, take |
Control de paginación. |
Pasos:
-
Reemplace
{id}por el ID del cliente. -
Escriba las fechas en formato
YYYY-MM-DD. -
Envíe la petición.
-
Verifique que el resultado sea 200 OK.
-
Si no hay registros, el sistema devolverá un arreglo vacío en
data.items
Consultar reservas por ID
Ruta: GET {BASE_URL}/api/public_api/clients/by_identification/{document}/reservations
Uso:
Permite consultar las reservas asociadas a un cliente a través de su número de documento.
Ejemplo:
