The iVector Universal API is a multi-tenant API gateway providing unified access to travel booking and management services. It acts as a proxy to downstream backend APIs — handling authentication, tenant resolution, and credential management centrally.
All endpoints are versioned with a /v1/ prefix. The base URL structure is:
https://<host>/v1/booking/... (Booking Services endpoints)
https://<host>/v1/core/... (Core Services endpoints)
https://<host>/v1/dealfinder/... (DealFinder — cached search endpoints)
https://<host>/v1/store/... (JSON Store — per-tenant JSON document storage)
https://<host>/v1/ops/{module}/... (Ops Services — operational tools, one path per module)
All requests require an API key passed in the x-api-key HTTP header:
x-api-key: your_api_key_here
To obtain an API key, contact Intuitive and we will create one for you in AWS. Each API key is associated with a specific tenant and environment (e.g., Test or Live), and determines which backend system your requests are routed to.
Content-Type header to application/json for all requests with a body.snake_case conventionYYYY-MM-DD (e.g., 2025-06-15)YYYY-MM-DDTHH:mm:ssZ)Errors are returned with an appropriate HTTP status code and a JSON body containing a machine-readable error code and a human-readable message:
{
"code": "ERROR_CODE",
"message": "Human-readable error description"
}
HTTP Status Codes:
| Status | Error Code | Description |
|--------|-----------|-------------|
| 400 | GATEWAY_BAD_REQUEST | The request was malformed or contained invalid parameters |
| 401 | GATEWAY_UNAUTHORIZED | Invalid or missing API key |
| 403 | GATEWAY_TENANT_DISABLED | Tenant account is disabled |
| 422 | GATEWAY_VALIDATION_ERROR | Request body failed validation |
| 429 | GATEWAY_RATE_LIMITED | Rate limit exceeded |
| 500 | GATEWAY_INTERNAL_ERROR | Unexpected internal server error |
| 502 | GATEWAY_BACKEND_ERROR | Backend service returned an error |
| 504 | GATEWAY_BACKEND_TIMEOUT | Backend service did not respond in time |
Example — Server Error (500):
{
"code": "GATEWAY_INTERNAL_ERROR",
"message": "An unexpected error occurred while processing your request."
}
Example — Validation Error (422):
{
"code": "GATEWAY_VALIDATION_ERROR",
"message": "Validation failed: 'arrival_date' is required; 'duration' must be between 1 and 30."
}
A comprehensive travel booking API that enables search, pricing, and booking of travel components including properties, flights, transfers, car hire, and extras. Endpoints are prefixed with /v1/booking/.
A typical booking flow follows these steps:
/v1/booking/properties/search)/v1/booking/properties/prebook)/v1/booking/basket/book)A REST/JSON CRUD API providing direct access to system tables for administration, configuration, and data management. Endpoints are prefixed with /v1/core/. In addition to the standard API key, Core Services requests require an X-SystemUser-Email header identifying the system user performing the operation.
A read-only cached search API for pre-computed availability and pricing, used to drive fast front-end search and calendar views. Endpoints are prefixed with /v1/dealfinder/ and grouped by area — availability/ (open dates, durations and months), packages/ (flight + hotel search, calendar, facets, details) and hotel-only/ (hotel search, calendar, facets, details). All calls are GET with query parameters, and responses use DealFinder's {data, meta, success} envelope.
A general-purpose per-tenant JSON document store for data that has no dedicated iVector table. Items are arbitrary JSON payloads addressed by type (a grouping label) and key (unique within the type), with paginated listing, exact-match field search (dot notation supported), atomic bulk create, and delete-with-archive. Endpoints are prefixed with /v1/store/. Request bodies pass through to the backing store without gateway-side validation, so the documented request schemas describe the expected shape rather than an enforced one.
Requests the gateway sends to you, declared under the OpenAPI 3.1 webhooks section rather than paths (they are not endpoints you call). Register a target URL per tenant environment, verify it with the one-time challenge handshake, then subscribe to event types.
Every delivery carries the same ids-only envelope: the payload identifies what changed, and you call back to the API for the detail. Deliveries are signed with a per-subscription secret in an X-IVector-Signature header (t=, HMAC-SHA256 over the raw body) — verify it over the raw bytes and reject stale timestamps to prevent replay. Any 2xx marks a delivery complete; anything else is retried with backoff and eventually dead-lettered. One event fans out to every matching subscription, so deduplicate on (event_id, trigger_id).
The webhook entries are grouped by payload shape, not one per event type — every event type shares the envelope. The event_type enum on each payload schema lists all the event types that produce that shape.
Operational endpoints surfacing iVector business modules — pricing, inventory, etc. — that don't fit a single CRUD table. Endpoints are organised by module under /v1/ops/{module}/... (for example /v1/ops/flights/charter-flight-pricing). Each module is backed by a separate downstream service per environment, but all share the same authentication contract: API key plus an X-SystemUser-Email header identifying the system user performing the operation.
--compressed)Booking & search API — /v1/booking/
CRUD administration API — /v1/core/
Cached search API — /v1/dealfinder/
Supplier room name standardisation, grouping and dedupe — /v1/roommapping/
Operational module APIs — /v1/ops/{module}/