API keys enable Tourism Accelerator to securely share data with other software. For example, automatically send booking details to your CRM or keep availability up-to-date across multiple platforms, saving time and improving efficiency.
Accessing this feature
Go to Admin > Api Access Rules
How to use it
Follow these steps to set up API access.
Generating a New API Key
On the API Access page, click Generate New API Key.
Enter a "Key Name". This is important for staying organised. For example, if you're connecting your website's booking form, you might name it "Website Booking Integration". If it's for your CRM, maybe "CRM Sync." Use descriptive names so you always know what each key is connected to.
Set Permissions (If Applicable): You might see options to set specific "Permissions" for your API key. These permissions control what the key can and cannot do. For instance, you might create a key that can read booking information but not change it. If you're unsure, it's often best to start with the default permissions or consult with the developer who will be using the key. If you don't see this option, your key will have standard access.
Click Create. A unique string of characters will be displayed – that's your API key. It will look like a long, jumbled sequence of letters and numbers.
Copy Your API Key IMMEDIATELY. For security reasons, we only show you the full API key once. Once you navigate away from this page, you won't be able to see the full key again. Click the Copy button next to your new API key. Paste it somewhere safe and secure, like a password manager or a secure document that only you (and authorised personnel) can access. You'll need this key to connect Tourism Accelerator with your other applications.
After copying your key, you're all set. You'll see your new key listed in the "Your API Keys" section, along with its name and the date it was created.
Tips
API Key Benefits
With your new API key, a whole world of possibilities opens up for streamlining your tourism business. Here are a few of the amazing things you can now do:
Synchronise Bookings: Automatically send new booking details from Tourism Accelerator to your chosen CRM, marketing automation platform, or accounting software.
Update Availability: Keep your inventory and availability accurate across multiple booking channels or your own website without manual updates.
Power Custom Reports: Pull specific data from Tourism Accelerator into your business intelligence tools to create personalised dashboards and gain deeper insights.
Automate Guest Communications: Trigger personalised welcome emails, pre-arrival instructions, or post-stay feedback requests based on booking events.
Build Custom Integrations: If you have a unique system or a preferred app, a developer can use this key to build a custom connection just for your business.
Integrate with Your Website: Connect your website's booking forms or information displays directly with Tourism Accelerator for real-time data.
API Key Security and Best Practices
To make sure your API access works securely, here are a few tips:
Plan Ahead: Before generating a key, think about which specific application or service you want to connect. This helps you name your key clearly and understand its purpose.
Keep Your Keys Safe: Treat your API keys like highly sensitive passwords. Never share them publicly (like on social media or in unencrypted emails). Store them securely, perhaps in a dedicated password manager.
One Key, One Purpose (Ideally): While you can use one key for multiple integrations, it's often best practise to create a separate key for each major integration. This way, if you ever need to revoke access for one service, you don't affect the others.
Test, Test, Test: Once you've set up an integration using your API key, always do a thorough test to make sure everything is working exactly as you expect. Make a test booking, for example, and see if it flows through correctly.
Consult a Developer: If you're new to APIs or want to build a complex integration, it's perfectly okay (and often recommended!) to work with a web developer. They can help you understand the technical details and make sure a smooth, secure connection.
Review Regularly: Every now and then, return to your API Access page. Review the keys you have active. If you're no longer using an integration, it's good practise to delete the associated API key to maintain security.
Need help?
For further assistance, contact us at [email protected]