Descubre el catálogo
Servicios, hoteles, zonas y tiempos de traslado.
Integra experiencias, reservas y pagos con The Boss System. Una API para llevar tu agencia del catálogo a la próxima aventura.
https://backoffice.thebosscaribbeantravel.com/api/v1Servicios, hoteles, zonas y tiempos de traslado.
Crea y consulta las órdenes de tu agencia.
Enlaces de Aloha Pay y consulta de estado.
PRIMEROS PASOS
Solicita tu clave al administrador después de la aprobación de tu agencia. Cada clave limita las consultas a su empresa y a sus propias reservas.
Envía X-API-Key o Authorization: Bearer con la misma clave privada. No es un JWT ni la contraseña del login. Mantén la clave fuera del navegador y de repositorios públicos.
GET /services para obtener códigos reales.EXPLORADOR EN VIVO
Consulta el catálogo público sin credenciales. Este explorador solo hace lecturas; las operaciones privadas se preparan en el generador de ejemplos de la derecha.
Selecciona un recurso y ejecuta una consulta para ver su respuesta real.
REFERENCIA · V1
Selecciona una operación para ver sus parámetros. El ejemplo se actualiza automáticamente en el panel de código.
No hay endpoints con ese término. Prueba con «reserva», «services» o «aloha».
/services+Consultar catálogo de serviciosConsultar catálogo de servicios. Requiere una clave API activa de agencia.
Revisa pricing_model y min_passengers: per_pair es el precio base para dos personas y se calcula proporcionalmente desde dos pasajeros; per_person es por persona; los traslados passenger_tier se tarifan por ruta y capacidad.
/transfer-catalog+Consultar zonas, aeropuertos, hoteles y tiemposConsultar zonas, aeropuertos, hoteles y tiempos. Requiere una clave API activa de agencia.
/orders+Listar reservas de la agenciaListar reservas de la agencia. Requiere una clave API activa de agencia.
| Nombre | Ubicación | Tipo |
|---|---|---|
per_page | query | integer |
page | query | integer |
status | query | string |
/orders+Crear reservaCrear reserva. Requiere una clave API activa de agencia.
| Campo | Tipo / condición |
|---|---|
service_code | stringCódigo obtenido en GET /services |
customer_namerequerido | string · hasta 180 caracteres |
travel_daterequerido | string · date |
travel_timerequerido | string |
passengersrequerido | integer · mínimo 1 |
customer_email | string · email |
customer_phone | string · hasta 80 caracteres |
country_code | string · hasta 2 caracteres |
order_type | string |
client_reference | string · hasta 120 caracteres |
hotel_name | string · hasta 180 caracteres |
pickup_location | string · hasta 220 caracteres |
dropoff_location | string · hasta 220 caracteres |
quantity | integer · mínimo 1 |
flight_number | string · hasta 90 caracteres |
promo_code | string · hasta 60 caracteres |
client_notes | string |
luggage_suitcases | integer · mínimo 0 |
luggage_handbags | integer · mínimo 0 |
children_under_one | integer · mínimo 0 |
children_over_one | integer · mínimo 0 |
baby_seat_count | integer · mínimo 0 |
/orders/{orderCode}+Consultar reserva y seguimientoConsultar reserva y seguimiento. Requiere una clave API activa de agencia.
| Nombre | Ubicación | Tipo |
|---|---|---|
orderCode requerido | path | string |
/orders/{orderCode}/payments/aloha+Listar pagos Aloha PayListar pagos Aloha Pay. Requiere una clave API activa de agencia.
| Nombre | Ubicación | Tipo |
|---|---|---|
orderCode requerido | path | string |
/orders/{orderCode}/payments/aloha/link+Crear o reutilizar enlace de pagoCrear o reutilizar enlace de pago. Requiere una clave API activa de agencia.
| Nombre | Ubicación | Tipo |
|---|---|---|
orderCode requerido | path | string |
Idempotency-Key | header | string |
| Campo | Tipo / condición |
|---|---|
amount | number · mínimo 0.5 |
success_url | string · uriURL HTTPS |
idempotency_key | string · hasta 100 caracteres |
DEL CATÁLOGO AL PAGO
Utiliza sus códigos reales, moneda y condiciones. Los importes de v1 son números decimales en la moneda de la respuesta.
Envía nombre, fecha, hora y pasajeros a POST /orders. Conserva el order_code devuelto y revisa su estado; una creación no demuestra que el servicio esté confirmado.
Usa POST /orders/{orderCode}/payments/aloha/link. Admite amount ≥ 0.50, success_url HTTPS e Idempotency-Key para reutilizar el mismo intento.
Consulta la orden y sus pagos. Volver a success_url no es una prueba de pago verificado.
La creación de órdenes no tiene una clave de idempotencia documentada: consulta tus reservas antes de repetir un POST cuya respuesta se perdió. client_reference es una referencia, no garantiza deduplicación. La idempotencia sí está disponible al generar el enlace de Aloha Pay.
COMPORTAMIENTO DE LA API
| Estado | Qué significa |
|---|---|
200 / 201 | Consulta correcta o recurso creado. Revisa también el estado de negocio. |
401 | Clave ausente, inválida o revocada; agencia o empresa inactiva. |
403 / 404 | Acceso no permitido o recurso fuera de tu alcance. |
422 | Revisa message, errors o error para corregir la solicitud. |
429 | Reduce la frecuencia y respeta Retry-After cuando se devuelva. |
OTROS CANALES
Base: https://backoffice.thebosscaribbeantravel.com/api/public. No utiliza la clave de agencia. Los tokens de solicitud, reserva y calendario son privados y dan acceso solo a ese recurso.
| Método | Ruta |
|---|---|
| GET | /tours · /hotels |
| POST | /availability · /quotes · /bookings |
| POST | /requests · /leads · /transfer-requests |
| GET | /requests/{token}/status · /bookings/{token}/status |
| POST | /requests/{token}/checkout · /bookings/{token}/checkout |
| POST | /requests/{token}/opt-out |
| GET | /payment-plans/{id}/{token} |
| POST | /payment-plans/{id}/{token}/checkout |
| GET | /payment-plans/{id}/{token}/receipt |
| POST | /events |
El flujo B2C necesita cotización y consentimiento; para integrar una agencia utiliza v1. La ingestión de flota usa POST /api/v1/fleet/gps/{vehicle}, encabezado X-GPS-Token por vehículo y límite 120/minuto.
CRECE CON THE BOSS
El equipo puede compartir un enlace con /registro/agencia?codigo=TU_CODIGO. El formulario conserva el código al crear la solicitud y asocia las futuras reservas a su acuerdo comercial.
El código no es una clave API, no aprueba la agencia ni permite consultar porcentajes de socios. La administración del acuerdo es privada.
Conoce el programa de agencias →