Skip to content

Access levels

Luis Rosales Carrera edited this page Oct 21, 2024 · 8 revisions

The API has different levels, controlling the access to the information or the ability to POST bookings. If you are unsure about your level, you can call the /{version}/configuration/privileges endpoint.

Endpoints

There is a different set of endpoints available for each access level.

Level Available Endpoints
BASIC/LIMITED_READ /configuration/{version}
/{version}/configuration/privileges
/{version}/categories
/{version}/categories/{category_id}
/{version}/tours
/{version}/tours/{tour_id}
Level Available Endpoints
READ /configuration/{version}
/{version}/configuration/privileges
/{version}/categories
/{version}/categories/{category_id}
/{version}/options/{option_id}
/{version}/suppliers/{supplier_id}
/{version}/tours
/{version}/tours/{tour_id}
/{version}/tours/{tour_id}/availability
/{version}/tours/{tour_id}/price-breakdown
/{version}/tours/{tour_id}/options
Level Available Endpoints
BOOKING /configuration/{version}
/{version}/configuration/payment
/{version}/configuration/privileges
/{version}/bookings
/{version}/bookings/{booking_hash}
/{version}/carts
/{version}/carts/{shopping_cart_hash}
/{version}/categories
/{version}/categories/{category_id}
/{version}/options/{option_id}
/{version}/suppliers/{supplier_id}
/{version}/tours
/{version}/tours/{tour_id}
/{version}/tours/{tour_id}/availability
/{version}/tours/{tour_id}/price-breakdown
/{version}/tours/{tour_id}/options

Formatting parameter

Some GET requests have the option to pass the query parameter preformatted, which controls the amount/composition of the information returned from the given endpoint.

Level Available formatting options
BASIC/LIMITED_READ teaser
READ teaser, full, home
BOOKING teaser, full, home
Clone this wiki locally