Quickstart: your first availability call
From a sandbox key to a bookable option in about fifteen minutes.
By Ipponsoft
This guide takes you from a sandbox key to a live availability response. You need a key issued by Ipponsoft and a terminal.
1. Authorise
Every request carries one header. The token is issued to you on onboarding and encodes both your username and the environment it belongs to.
Authorization: ApiKey [username]_[environment]_[secret]
Two environments exist:
| Environment | Base URL | Notes |
|---|---|---|
| Sandbox | https://demo.apixv.com |
Limited supply, booking disabled |
| Production | https://cloud.apixv.com |
Separate key, issued after certification |
Use the key that matches the environment. A production key will not authorise against sandbox, and the failure looks like a generic access-denied error.
2. Load reference data
curl --header "Authorization: ApiKey $APIXV_KEY" \
"https://demo.apixv.com/hotelxv/api/v2/datasets"
Cache this. It contains board codes, amenities and the reference data your application needs to render results, and it changes rarely.
3. Fetch hotel content
curl --header "Authorization: ApiKey $APIXV_KEY" \
"https://demo.apixv.com/hotelxv/api/v2/hotels?hotel_uids=AXH-qCzrQmMQvRPa,AXH-qCzrQmMWriE7"
Multiple UIDs are comma separated.
4. Request availability
curl --header "Authorization: ApiKey $APIXV_KEY" \
"https://demo.apixv.com/hotelxv/api/v2/options?hotel_uids=AXH-qCzrQmMQvRPa&check_in=2026-12-01&check_out=2026-12-10&occupancy=A-A-C9&market=nl¤cy=EUR&language=en&nationality=NL"
Each returned option carries an option_uid. That is what you confirm before booking.
Common mistakes
- Omitting the
ApiKeykeyword. The header value isApiKey <token>, not the bare token. - Storing UIDs. They are temporary identifiers. Resolve them rather than persisting them.
- Hardcoding board codes. Read them from
/datasets. - Wrong environment key. Check the middle segment of your token.
Next
Read the booking lifecycle guide to take an option through to a confirmed reservation.