Welcome to ATDW
This step-by-step guide is designed to help you harness ATDW content with confidence. Our experience shows that with the right approach, integrating ATDW’s API is a straightforward, manageable process—and if you need advice or support at any stage, our team is ready to help-connect with us.
Getting Started with the API
1. Assess your Technical Requirements
Before you begin, clarify what you want to achieve with your digital channels. Do you want to showcase accommodation, local events, or build a comprehensive tourism platform? Collaborate with your technical team to ensure you understand the requirements for API integration—this means:
Familiarity with RESTful APIs
Handling JSON or XML data formats; and
Planning how ATDW data will be synchronised and displayed on your digital channels
2. Explore the Core API Components
Before you start building, spend time familiarising yourself with the following:
API Guide: Understand the API’s features and how to make calls. See:
Content Structure: Review how our data is organised and think about how you’ll map this to your own systems.
API Endpoints: Identify which endpoints align with your business goals.
API Request Formats: Learn how to structure your requests.
API Response Formats: Understand how to process the returned data. See:
Integration Best Practices: Discover practical advice on efficiency, data quality, and long-term sustainability.
3. Set up the Integration
When you’re ready, use your Distributor Key to authenticate all API requests.
Start exploring example API calls and adjust their parameters (by category, location, or keyword) to preview the content you plan to feature.
4. Test and Review Content
Run your example queries to retrieve live content. The goal is to check if your queries are working: are you retrieving the right types of profiles and categories, and do they look correct for your intended use?
This is about previewing the content as your end users would see it—making sure it matches your needs and is displayed as you expect. Take time to review what is returned, checking the coverage, data quality, formatting, and how quickly the API responds.
5. Implement Tracking
Embed required tracking mechanisms to monitor user engagement and comply with the Distribution Licence Agreement. This includes:
Web Beacons
Image URL Tracking
Contact & Booking URL Tracking
6. Test and Validate Using the Sandbox
Before moving to live production, switch to the our sandbox environment to thoroughly and systematically test your integration—see: Testing your API Integration for details. This will give you an opportunity to fully validate data accuracy, error handing, tracking implementation and content display before moving to production.
7. Confirm Publishing with ATDW
Before going live, notify our team about which categories and locations you intend to publish. This keeps records accurate and ensures a smooth launch.
8. Go Live
Once testing is complete and tracking is in place, switch to your production API key and endpoints.
9. Monitor and Maintain
Continue to monitor and refine your integration to ensure a seamless experience for your users. Regularly monitor API usage, performance, and data freshness. Implement caching, pagination, and delta updates to optimise efficiency and keep content current.
Frequently Asked Questions
Where can I find my Distributor Key?
Your Distributor Key was provided as part of your welcome email from us and it's available in our platform. Simply login and navigate to your account dashboard. If you can’t locate your distributor key, contact us for assistance.
Where do I find my package type?
Your package type determines your access level and available API features. You can find your package type in your ATDW distributor welcome email or by logging in to your ATDW account dashboard. If you require clarification on your package or wish to upgrade—connect with us.
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.