Integrating the ATDW API into your digital channels is a strategic way to access and showcase Australia’s most comprehensive tourism content. To help you navigate this journey smoothly, here’s a detailed process outlining each key step - from initial assessment to going live.
Step 1: Assess your Technical Requirements
Before you begin, ensure your technical team understands the requirements for API integration. This includes familiarity with RESTful APIs, handling JSON or XML data formats, and managing data synchronisation and display on your platform.
Step 2: Create a Distributor Account
Register as a distributor (See: How to Join as a Distributor) to start your 30-day free trial.
Step 3: Confirm your Distribution Plan
At the end of the trial, select a distribution package that meets your business needs. Once confirmed and fees paid you will receive your API Key.
Step 4: Review Documentation
Familiarise yourself with the API Guide. This comprehensive resource details all available endpoints, request formats, response structures, and best practices.
Step 5: Set up the Integration
Use your API key to connect your platform to the API. Implement calls to relevant endpoints such as Search, Get Product, and Get Service to fetch and display tourism content tailored to your audience.
Step 6: Implement Tracking
Embed required tracking mechanisms, including Web Beacons, Image URL Tracking, and Contact & Booking URL Tracking (See: Tracking Requirements), to monitor user engagement and comply with the Distribution Licence Agreement.
Step 7: Test and Validate
Utilise the sandbox environment to test your integration thoroughly. Validate data accuracy, error handling, and user experience before moving to production.
Step 8: Monitor and Maintain
Regularly monitor API usage, performance, and data freshness. Implement caching, pagination, and delta updates to optimise efficiency and keep content current.
Step 9: Go Live
Once testing is complete and tracking is in place, switch to your production API key and endpoints. Continue to monitor and refine your integration to ensure a seamless experience for your users.
Resources to assist with your Integration
Need Assistance Integrating the API into your Digital Channels?
If you need any assistance or run into any issues while integrating the API, we're here to help. Discover how to access Support when and where it's needed.