Getting Started with Nuitee Cloud
Guide for suppliers integrating with Nuitee Cloud ARI — static data, daily ARI, and webhooks for price check and reservation delivery.
Getting started with Nuitee Cloud ARI
Nuitee Cloud ARI is the supplier inbound API used by PMS, channel managers, and connectivity partners to send hotel content, room/rate catalog, and daily availability and pricing to Nuitee Cloud. That data powers distribution and booking across Nuitee Cloud channels.
New here? Run the integration in your terminal first: Quick start — runnable examples (copy-paste curl, expected responses, checklist).
In simple terms
| You send | Nuitee Cloud uses it to… |
|---|---|
| Hotel details | Know which properties you operate |
| Rooms & rates | Know what products exist (roomId + rateId) |
| Daily ARI | Know price, availability, and rules per date |
| Webhook URLs | Call you at booking time (price check + reservations) |
| Taxes | Know what taxes apply and how they're charged |
Your hotelId, roomId, and rateId are your codes — keep them identical in every API call and in webhook payloads.
Who this is for
Technical and operations teams at suppliers (PMS, channel manager, CRS, custom integrators) onboarding properties onto Nuitee Cloud.
What you will integrate
- Static data — hotels, room/rate products, and taxes
- ARI — date-range availability, rates, inventory, and restrictions
- Webhooks — HTTPS endpoints on your side for live price check and reservation push
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox / dev | https://ari-dev.thehotelplanet.com/v1 |
| Production | https://ari.thehotelplanet.com/v1 |
Authentication
Send your API key on every request:
x-api-key: YOUR_API_KEYX-API-KEY is equivalent (headers are case-insensitive). Contact Nuitee Cloud onboarding to receive sandbox and production keys. Keys are tied to your supplier account; webhook URLs are stored on the same API key record.
Pricing models (important)
ARI pushes use pricingModel on POST /push/ari:
| Value | Meaning |
|---|---|
unit | Price per room/unit per night |
guest | Price per guest bucket — send guests and ageCategory (adult, child, infant) on each rate line |
Use lowercase guest and unit in production payloads. Validation may accept other casing, but guest-specific fields are applied when the model is exactly guest.
Note: Older documentation referred to Daily and LOS as pricing models. The ARI gateway does not use those values. Length-of-stay rules are optional fields on each rate (
minLengthStay,maxLengthStay,minStayArrival,maxStayArrival, etc.).
Recommended integration order
flowchart LR A[POST /push/hotels] --> B[POST /push/products] B --> C[POST /push/ari] B --> D[POST /push/taxes] E[Register webhooks] --> F[Go live] C --> F
| Step | Endpoint | Required for go-live |
|---|---|---|
| 1 | POST /push/hotels | Yes — register each hotelId |
| 2 | POST /push/products | Yes — room and rate catalog |
| 3 | POST /push/taxes | Yes if the property has taxes to configure |
| 4 | POST /push/ari | Yes — ongoing inventory and rates |
| 5 | POST /push/webhook/availability | Yes if your contract uses live price check at book time |
| 6 | POST /push/webhook/pushbook | Yes if you receive reservations via HTTP push |
Rules:
- Push hotels before products; push products before ARI for the same property.
- Webhook registration (steps 4–5) can happen in parallel with static setup, but your endpoints must be live before booking goes to production.
- Registering a webhook URL only stores the URL — you must implement the callback and pass end-to-end tests with Nuitee Cloud.
How the pieces connect
flowchart LR
subgraph You["Your system"]
PMS[PMS / channel manager]
PC[Price-check URL]
PB[Push-booking URL]
end
subgraph NC["Nuitee Cloud"]
ARIgw[ARI gateway]
Core[ARI core engine]
Book[Booking API]
Worker[Reservation delivery]
end
PMS -->|POST /push/hotels, /products, /ari| ARIgw
ARIgw --> Core
PMS -->|POST register webhooks| ARIgw
Book -->|POST live price check| PC
Worker -->|POST reservations| PB
Supplier codes (hotelId, roomId, rateId) in your API calls are mapped to Nuitee Cloud internal IDs. Use the same codes in static data, ARI, and when interpreting webhook payloads.
Obtaining API credentials
- Nuitee Cloud account — contact support or onboarding for supplier access.
- API key — request sandbox and production keys for the ARI environment.
- Authentication — send the key in the
x-api-keyheader on all requests.
Key APIs for integration
| API | Path | Purpose |
|---|---|---|
| Hotels list | POST /push/hotels | Create or update hotels (max 500 per request) |
| Hotel products | POST /push/products | Room and rate catalog per hotel |
| Taxes | POST /push/taxes | Property-level and product-scoped tax configuration |
| ARI push | POST /push/ari | Daily availability, rates, inventory, restrictions |
| Price-check webhook | POST /push/webhook/availability | Register URL for live price validation |
| Push-booking webhook | POST /push/webhook/pushbook | Register URL for reservation delivery |
Optional platform endpoints (confirm with onboarding): POST /push/getHotels, POST /push/getRoomRateMappings, POST /push/getTaxes, POST /push/webhook/booking, GET /push/webhook/pushbook/retrieve.
Next steps
- Static data — Hotels content
- ARI push — Availability - Rate - Inventory
- Booking — Retrieve/Push bookings
- Webhooks — Receive notifications for the following actions: booking, cancellation, and price check.
Updated about 1 month ago