Skip to main content

What is an API Key?

An API key is a unique identifier issued to your organisation when you register as a distributor partner.

Updated over 3 weeks ago

An API key is a unique identifier issued to your organisation when you register as a distributor partner. This key is essential for authenticating and authorising your access to the API - allowing you to request, display, and manage tourism content across your digital channels.


How It Works

  • Authentication: Every time your system makes a request to our API - such as fetching accommodation listings, attractions, or events - you must include your API key. This key tells the system who is making the request and verifies that you are authorised to access the data.

  • Access Control: The API key is unique to your organisation and is tied to your specific distributor privileges. It ensures that only licensed distributors can retrieve and display our content, protecting the integrity of the data and the tourism network.

  • Usage Monitoring: The API key also allows us to monitor and control how the API is used, helping to maintain service quality and fair usage for all distributors.


Where to Find and Use Your API Key

  • Registration: When you register as a distributor, you receive your API key after you've completed your 30-day free trial and your account is approved.

  • In the platform: You can also access your key via your distributor dashboard within the platform.

  • API Requests: Include your API key in every request to the API - typically as a query parameter or in the request header, as specified in the API Guide.

  • Sandbox and Production: You may receive a separate key for testing in the sandbox environment and another for live (production) use. Always use the correct key for your environment.


Best Practices for Managing Your API Key

Keep It Secure: Treat your API key like a password. Do not share it publicly or embed it in client-side code. Store it securely on your server.

Monitor Usage: Regularly review your API usage to ensure your key has not been compromised or misused.

Report Issues: If you suspect your API key has been exposed, contact us immediately to have it disabled and replaced.


Why It Matters

Your API key is fundamental to accessing and leveraging our data. It ensures secure, controlled, and accountable use of the platform; helping you deliver the best possible experience to your customers while protecting the interests of the wider tourism community

Did this answer your question?