API Reservas — Documentación

Historial de Cambios

Versión	Ítem	Autor	Descripción	Fecha
v 1.0	Creación	Bruce Garriazo	Sin documento previo	28-10-2024
v 1.1	Actualización	Jeremy Lopez	Se agregan los endpoints enviar-xml-ftp y enviar-cdr-ftp; enviar-vouchers-ftp queda dedicado solo a PDF	09-09-2026

1. Introducción

El siguiente conjunto de servicios API REST se encuentran disponibles para ser consumidos por cualquier cliente, donde se gestionan emisiones, envío de documentos (PDF, XML y CDR) y reporte de cambios y anulaciones.

2. Autenticación

La autenticación está basada en BasicAuth, por lo que en cada petición se debe enviar el header Authorization con las credenciales de usuario y contraseña codificadas en base64. Es importante tener en cuenta que el usuario y la contraseña son los mismos que se utilizan para ingresar al sistema de reservas.

Authorization: Basic TEFUSU5UT1VSOkdoZXJtYWluJDIwMDk=

3. Emisiones

El API cumple con las siguientes funcionalidades:

Filtrado por Fechas: Permite obtener las emisiones registradas dentro del intervalo de fechas especificado.
Paginación: Soporta la paginación para manejar y presentar los datos de manera eficiente, especialmente cuando se trabaja con grandes volúmenes de información.

3.1. Solicitud

GET /api/consulta/emisiones

3.2. Parámetros

Atributo	Requerido	Descripción
fecha_inicio	Sí	Fecha de inicio del intervalo de fechas a consultar. Formato: YYYY-MM-DD.
fecha_fin	Sí	Fecha de fin del intervalo de fechas a consultar. Formato: YYYY-MM-DD.
page	No	Número de página a consultar. Por defecto: 1.
limit	No	Cantidad de registros por página. Por defecto: 50.
tipo_ruta	No	Tipo de ruta a consultar. Por defecto: %. Valores permitidos: 2 (Nacional), 1 (Internacional) y % (Todos).

3.3. Respuesta

Status Code: 200 OK

Status Code: 400 Bad Request

{
  "message": "Los campos fecha_inicio y fecha_fin son requeridos.",
  "extra": null
}

Nota: Considerar como respuesta exitosa cuando el status code es 200 OK.

4. Envío de Vouchers PDF a FTP

El API cumple con las siguientes funcionalidades:

Generación de Vouchers: Para cada documento en el array, el servidor generará el voucher correspondiente en formato PDF.
Conexión al Servidor FTP: Utilizando las credenciales proporcionadas, el servidor establecerá una conexión con el servidor FTP especificado.
Transferencia de Archivos: Los vouchers PDF generados serán enviados al servidor FTP.

4.1. Solicitud

POST /api/consulta/enviar-vouchers-ftp

{
  "host": "ftp.fragote.com",
  "port": "21",
  "username": "fptest@fragote.com",
  "password": "test",
  "protocol": "FTPS",
  "documentos": [
    "FA-F001-00649646",
    "BV-B224-00020641"
  ]
}

4.2. Parámetros

Atributo	Requerido	Descripción
host	Sí	Dirección IP o nombre de dominio del servidor FTP.
port	Sí	Puerto de conexión al servidor FTP.
username	Sí	Nombre de usuario para la conexión al servidor FTP.
password	Sí	Contraseña para la conexión al servidor FTP.
protocol	Sí	Protocolo de conexión al servidor FTP. Valores permitidos: FTP y FTPS.
documentos	Sí	Array con los códigos de documentos a generar y enviar en formato PDF.

Nota 1: Los códigos de documentos deben tener el formato: (codigo_documento)-(prefijo_documento)-(numero_documento).
Nota 2: Los PDF generados se almacenarán en la carpeta raíz del servidor FTP.

4.3. Respuesta

Status Code: 200 OK

Status Code: 400 Bad Request

Nota: Considerar como respuesta exitosa cuando el status code es 200 OK.

5. Envío de XML a FTP

El API cumple con las siguientes funcionalidades:

Generación de XML: Para cada documento en el array, el servidor obtiene el XML firmado correspondiente.
Conexión al Servidor FTP: Utilizando las credenciales proporcionadas, el servidor establecerá una conexión con el servidor FTP especificado.
Transferencia de Archivos: Los XML obtenidos serán enviados al servidor FTP.

5.1. Solicitud

POST /api/consulta/enviar-xml-ftp

{
  "host": "ftp.fragote.com",
  "port": "21",
  "username": "fptest@fragote.com",
  "password": "test",
  "protocol": "FTPS",
  "documentos": [
    "FA-F001-00649646",
    "BV-B224-00020641"
  ]
}

5.2. Parámetros

Atributo	Requerido	Descripción
host	Sí	Dirección IP o nombre de dominio del servidor FTP.
port	Sí	Puerto de conexión al servidor FTP.
username	Sí	Nombre de usuario para la conexión al servidor FTP.
password	Sí	Contraseña para la conexión al servidor FTP.
protocol	Sí	Protocolo de conexión al servidor FTP. Valores permitidos: FTP y FTPS.
documentos	Sí	Array con los códigos de documentos a generar y enviar en formato XML.

Nota 1: Los códigos de documentos deben tener el formato: (codigo_documento)-(prefijo_documento)-(numero_documento).
Nota 2: Los XML generados se almacenarán en la carpeta raíz del servidor FTP.

5.3. Respuesta

Status Code: 200 OK

Status Code: 400 Bad Request

Nota: Considerar como respuesta exitosa cuando el status code es 200 OK.

6. Envío de CDR a FTP

El API cumple con las siguientes funcionalidades:

Generación de CDR: Para cada documento en el array, el servidor obtiene la Constancia de Recepción (CDR) correspondiente.
Conexión al Servidor FTP: Utilizando las credenciales proporcionadas, el servidor establecerá una conexión con el servidor FTP especificado.
Transferencia de Archivos: Los CDR obtenidos serán enviados al servidor FTP.

6.1. Solicitud

POST /api/consulta/enviar-cdr-ftp

{
  "host": "ftp.fragote.com",
  "port": "21",
  "username": "fptest@fragote.com",
  "password": "test",
  "protocol": "FTPS",
  "documentos": [
    "FA-F001-00649646",
    "BV-B224-00020641"
  ]
}

6.2. Parámetros

Atributo	Requerido	Descripción
host	Sí	Dirección IP o nombre de dominio del servidor FTP.
port	Sí	Puerto de conexión al servidor FTP.
username	Sí	Nombre de usuario para la conexión al servidor FTP.
password	Sí	Contraseña para la conexión al servidor FTP.
protocol	Sí	Protocolo de conexión al servidor FTP. Valores permitidos: FTP y FTPS.
documentos	Sí	Array con los códigos de documentos a generar y enviar en formato CDR.

Nota 1: Los códigos de documentos deben tener el formato: (codigo_documento)-(prefijo_documento)-(numero_documento).
Nota 2: Los CDR generados se almacenarán en la carpeta raíz del servidor FTP.

6.3. Respuesta

Status Code: 200 OK

Status Code: 400 Bad Request

Nota: Considerar como respuesta exitosa cuando el status code es 200 OK.

7. Cambios y Anulaciones

El API cumple con las siguientes funcionalidades:

Reporte de Cambios y Anulaciones: Proporciona una lista detallada de todos los cambios y anulaciones realizados dentro del intervalo de fechas especificado.
Paginación: Facilita el manejo de grandes cantidades de datos.

7.1. Solicitud

GET /api/consulta/cambios-anulaciones

7.2. Parámetros

Atributo	Requerido	Descripción
fecha_inicio	Sí	Fecha de inicio del intervalo de fechas a consultar. Formato: YYYY-MM-DD.
fecha_fin	Sí	Fecha de fin del intervalo de fechas a consultar. Formato: YYYY-MM-DD.
page	No	Número de página a consultar. Por defecto: 1.
limit	No	Cantidad de registros por página. Por defecto: 50.
tipo_ruta	No	Tipo de ruta a consultar. Por defecto: %. Valores permitidos: 2 (Nacional), 1 (Internacional) y % (Todos).

7.3. Respuesta

Status Code: 200 OK

Status Code: 400 Bad Request

{
  "message": "Los campos fecha_inicio y fecha_fin son requeridos.",
  "extra": null
}

Nota: Considerar como respuesta exitosa cuando el status code es 200 OK.