At the end of the Golden Path, you will have an API integration that allows your users to search for or select a destination, browse for and choose products, and then users are redirected to viator.com to complete the final transaction for which you will earn a commission.

This Golden Path may not be the only path you try out. You should follow the path that makes the most sense for your business and your site or app. However, we recommend starting with this particular implementation as it’s the most common for our API partners and by getting through the steps, you get a better feel for what’s possible with our API.

User flow

user flow golden path

The Golden Path: Building the Foundation 

The steps:

1

Generate your API key in your account dashboard

You can generate an API key immediately at any time. In your account go to Tools → Affiliate API → Start your development. Then you’ll need to verify your email address before you get your key.

2

Test on Postman

To facilitate your testing of the API’s functionality, please use Viator Affiliate API Postman collection. Set up a Postman account here.

3

Get acquainted with our API documentation

Not everything in our documentation is relevant to your integration, so we recommend taking a look at which endpoints you, as a Basic-access Affiliate, have access to. From here, you can learn more about what each endpoint does and how it relates to your integration.

We also recommend looking at our technical guide for more information about our endpoints and what they allow you to do.

Generating your key (Step 1)

4

Establish a “things-to-do” vertical on your site

If you sell other products, like accommodations or flights, you’ll need to establish a dedicated “things-to-do” section of your site for tours and activities. The best way to set up this vertical on your site is via the navigation or directly on the search element.

Example of a “things to do” vertical on tripadvisor.com (Step 4)

5

Build your destination pages

Once your things-to-do vertical is established, you’ll want to set up destination pages because travelers often search for tours and activities by destination. Destination pages display a list of tours and activities that are returned by a request to the /products/search endpoint. On this page, you should:

  • Add sort functionality for the traveler to use (e.g. sort by price low to high)
  • Allow travelers to apply filters (e.g. filter for products with free cancellation)
  • Include an option to update the search (e.g. allow travelers to change their dates)
  • Sort/order the returned products (indicated in the initial request)

See our front end guide for more details on how to build out your front-end.

6

Implement destinations into your things-to-do pages

After setting up your things-to-do vertical, you’ll add structure by integrating our destinations that enable your customers to search for or find destinations.

Below we highlight two likely scenarios. The first, a destination search, is ideal for those operating across many destinations. This gives the user the ability to search for the destination in mind. The second, links to destination pages, is ideal for everyone but is important for those operating across a few destinations or even a single destination. Both scenerios use the same two endpoints to achieve the end result. 

Destination search

search element autofill

Having search functionality on your site is the quickest and easiest way that a traveler can find exactly what they’re looking for. The search functionality should be front and center and should include some basic search criteria like destination, travel dates, price ranges, or other filters (e.g. free cancellation products).

How to create a destination search:

  • Retrieve a list of destinations on a regular schedule (e.g. daily) using the /v1/taxonomy/destinations endpoint. Store this list in a database or in the cache.
  • Implement a search of the destination names from the list of destinations using the /products/search endpoint, making sure to apply any filters indicated by the traveler.

Links to destination pages

It is also useful for undecided travelers to merchandise a curated list of destinations. For example, you can create dropdown lists of destinations in your navigation or on combo boxes. You can also merchandise a list of top destinations on your things-to-do pages or cross sell experiences on other pages unrelated to things-to-do.

Creating links to destination pages:

  • Retrieve a list of destinations on a regular schedule (e.g. daily) using the /v1/taxonomy/destinations endpoint. Store this list in a database or in the cache.
  • Curate which destinations to show and where to show them on your site. Be sure to include the appropriate images and text.
  • When these destination links are clicked on, use the /products/search endpoint to populate products on your destination pages. Since this is not a user search, you would not necessarily include any particular filters for travel dates, price ranges or other filters.
7

Merchandise products with product previews

On your destination page, you’ll want to merchandise each product with a product preview using the information returned by a request to the /products/search endpoint, including product title, description, price, review rating, review count,the lead image, and the corresponding viator.com URL.

When a user clicks on one of the product reviews on your destination page, they will be sent to the corresponding viator.com product description page (PDP) where the traveler will complete their transaction.

You're ready to launch!

After you finish your own testing, you are ready to go live using the same API key you generated in step 1. You can also continue to build out your integration.

Example of two product previews from the Lima destination page on viator.com