API Overview
Qail provides APIs for maritime search, availability, booking, payment coordination, ticketing, WhatsApp operations, and webhook-based automation. This public page is an overview for technical due diligence, not a full implementation reference.
Public scope. This page confirms what the platform supports, how access is controlled, and where qualified teams can request the full reference.
Implementation detail is gated. Endpoint paths, payload schemas, webhook payloads, provider-specific payment flows, OpenAPI files, and error-code catalogs are shared only with qualified Enterprise/API clients.
Supported Capabilities
The public contract is intentionally described by capability area. Each area maps to a documented API module in the gated developer reference.
Search & Availability
Route search, schedule discovery, live capacity checks, next available date lookup, and price-calendar signals.
Booking & Payments
Draft orders, inventory holds, final booking creation, payment session orchestration, and payment-status reconciliation.
Ticketing & Boarding
Electronic ticket lifecycle, passenger manifests, boarding validation, and operational status updates.
WhatsApp Operations
Booking notifications, approved template delivery, service messages, customer handover, and inbox workflows.
Webhooks
Event delivery for booking, payment, ticketing, and messaging state changes with signature verification and retry handling.
Localization Utilities
Currency, timezone, and regional helpers for multi-market checkout and operator dashboards.
High-Level Booking Flow
The full API reference includes exact request structure, validation rules, state transitions, and provider behavior. Publicly, Qail exposes the flow at a product-integration level.
Find bookable trips using tenant-scoped route, date, vessel, and passenger filters.
Reserve inventory while checkout details and pricing are finalized.
Create or attach payment flow through the configured payment provider.
Confirm the booking, generate passenger ticket artifacts, and update operational records.
Deliver customer messages, operator alerts, webhook events, and status updates.
Security Model
Qail APIs are designed around tenant isolation and credential-derived scope. Public clients should not send tenant identity as a trust signal; tenant and capability scope are derived from issued credentials and server-side authorization.
| Control | Public Summary |
|---|---|
| Tenant-scoped access | API credentials are scoped to the tenant, partner, environment, and enabled modules. |
| Idempotency | Mutation flows support duplicate-safe retries for booking and payment-sensitive operations. |
| Webhook verification | Webhook consumers verify signatures and reject stale or replayed deliveries. |
| Operational separation | Dashboard, provider, platform, and internal automation APIs are not part of the public surface. |
| Credential handling | Secret keys, provider credentials, and BYOK settings are never documented in public payload examples. |
Public vs Gated Docs
This public page is intentionally high-level. Qualified teams receive a gated reference during implementation, after commercial qualification, security review, or NDA coverage.
| Public Overview | Gated Reference |
|---|---|
| Supported modules and integration flow | Exact endpoint paths, versions, headers, and environment details |
| Tenant-scoped and idempotent behavior | Request and response schemas, lifecycle state machines, and validation rules |
| Webhook support | Webhook event catalog, signature examples, retry policy, and payload structure |
| Payment and ticketing capability summary | Provider-specific payment channels, ticketing actions, boarding flows, and reconciliation behavior |
| Security posture and disclosure route | OpenAPI/Swagger files, SDK notes, sandbox credentials, and integration test cases |
Request Full API Access
Full API documentation is available for qualified operators, resellers, enterprise customers, and implementation partners. Access normally includes sandbox setup, module scoping, API reference, webhook guide, test cases, and implementation support.
Best next step. Share your target modules, expected transaction volume, payment provider requirements, WhatsApp requirements, and planned go-live timeline through the contact form.
Trust Signals
Qail keeps public security contact information available and can support deeper technical review for qualified teams.
| Area | Public Summary |
|---|---|
| Security disclosure | Security reports can be sent through the published vulnerability disclosure contact. |
| Architecture review | Qualified teams can review tenant isolation, credential boundaries, and webhook verification under NDA. |
| Implementation support | Enterprise/API clients receive scoped onboarding instead of relying on public implementation examples. |