DESARROLLADORES / DOCUMENTACIÓN
REST API · JSON · HTTPS

Tu plataforma.
El Caribe, conectado.

Integra experiencias, reservas y pagos con The Boss System. Una API para llevar tu agencia del catálogo a la próxima aventura.

URL BASE · AGENCIAShttps://backoffice.thebosscaribbeantravel.com/api/v1
01

Descubre el catálogo

Servicios, hoteles, zonas y tiempos de traslado.

02

Gestiona reservas

Crea y consulta las órdenes de tu agencia.

03

Conecta los pagos

Enlaces de Aloha Pay y consulta de estado.

PRIMEROS PASOS

Una clave. Tu agencia.

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.

Autenticación desde tu servidor

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.

1Registra tu agencia y espera la aprobación.
2Solicita una clave API vinculada a tu agencia.
3Consulta GET /services para obtener códigos reales.

EXPLORADOR EN VIVO

Prueba una consulta real.

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.

LISTO PARA CONSULTAR
Selecciona un recurso y ejecuta una consulta para ver su respuesta real.

REFERENCIA · V1

Endpoints de agencias

7 operaciones

Selecciona una operación para ver sus parámetros. El ejemplo se actualiza automáticamente en el panel de código.

GET/services+Consultar catálogo de servicios

Consultar 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.

200 Correcto401 Sin autorización422 Validación429 Límite
GET/transfer-catalog+Consultar zonas, aeropuertos, hoteles y tiempos

Consultar zonas, aeropuertos, hoteles y tiempos. Requiere una clave API activa de agencia.

200 Correcto401 Sin autorización422 Validación429 Límite
GET/orders+Listar reservas de la agencia

Listar reservas de la agencia. Requiere una clave API activa de agencia.

Parámetros

NombreUbicaciónTipo
per_pagequeryinteger
pagequeryinteger
statusquerystring
200 Correcto401 Sin autorización422 Validación429 Límite
POST/orders+Crear reserva

Crear reserva. Requiere una clave API activa de agencia.

Cuerpo JSON

CampoTipo / condición
service_codestringCódigo obtenido en GET /services
customer_namerequeridostring · hasta 180 caracteres
travel_daterequeridostring · date
travel_timerequeridostring
passengersrequeridointeger · mínimo 1
customer_emailstring · email
customer_phonestring · hasta 80 caracteres
country_codestring · hasta 2 caracteres
order_typestring
client_referencestring · hasta 120 caracteres
hotel_namestring · hasta 180 caracteres
pickup_locationstring · hasta 220 caracteres
dropoff_locationstring · hasta 220 caracteres
quantityinteger · mínimo 1
flight_numberstring · hasta 90 caracteres
promo_codestring · hasta 60 caracteres
client_notesstring
luggage_suitcasesinteger · mínimo 0
luggage_handbagsinteger · mínimo 0
children_under_oneinteger · mínimo 0
children_over_oneinteger · mínimo 0
baby_seat_countinteger · mínimo 0
200 Correcto201 Creado401 Sin autorización422 Validación429 Límite
GET/orders/{orderCode}+Consultar reserva y seguimiento

Consultar reserva y seguimiento. Requiere una clave API activa de agencia.

Parámetros

NombreUbicaciónTipo
orderCode requeridopathstring
200 Correcto401 Sin autorización422 Validación429 Límite
GET/orders/{orderCode}/payments/aloha+Listar pagos Aloha Pay

Listar pagos Aloha Pay. Requiere una clave API activa de agencia.

Parámetros

NombreUbicaciónTipo
orderCode requeridopathstring
200 Correcto401 Sin autorización422 Validación429 Límite
POST/orders/{orderCode}/payments/aloha/link+Crear o reutilizar enlace de pago

Crear o reutilizar enlace de pago. Requiere una clave API activa de agencia.

Parámetros

NombreUbicaciónTipo
orderCode requeridopathstring
Idempotency-Keyheaderstring

Cuerpo JSON

CampoTipo / condición
amountnumber · mínimo 0.5
success_urlstring · uriURL HTTPS
idempotency_keystring · hasta 100 caracteres
200 Correcto201 Creado401 Sin autorización422 Validación429 Límite

DEL CATÁLOGO AL PAGO

El flujo de una reserva.

  1. Consulta los servicios.

    Utiliza sus códigos reales, moneda y condiciones. Los importes de v1 son números decimales en la moneda de la respuesta.

  2. Crea la orden.

    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.

  3. Genera el enlace de pago.

    Usa POST /orders/{orderCode}/payments/aloha/link. Admite amount ≥ 0.50, success_url HTTPS e Idempotency-Key para reutilizar el mismo intento.

  4. Consulta la verificación.

    Consulta la orden y sus pagos. Volver a success_url no es una prueba de pago verificado.

Reintentos sin duplicados

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

Respuestas y límites.

EstadoQué significa
200 / 201Consulta correcta o recurso creado. Revisa también el estado de negocio.
401Clave ausente, inválida o revocada; agencia o empresa inactiva.
403 / 404Acceso no permitido o recurso fuera de tu alcance.
422Revisa message, errors o error para corregir la solicitud.
429Reduce la frecuencia y respeta Retry-After cuando se devuelva.
60/minAPI v1 · según clave o IP
40/minAPI pública B2C

OTROS CANALES

API de la web de clientes.

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étodoRuta
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

Registro de agencias por código.

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 →

Tu privacidad

Tu cuenta y tus pagos funcionan sin medición opcional.

Consultar privacidad