Using the Whereabouts API

Getting API Access

Please contact help@tourism.tech and let us know about your project. We are very selective about granting API access, but we'd love to hear what you're working on.

To access the api, you need an API key.

What the API Looks Like

Whereabouts has a GraphQL based API. For most partners, we will give you a query that will pull every possible field per Operator in your Whereabouts database.

For example, using CURL, you can easily return a rich object:

curl --request POST \
  --header 'content-type: application/json' \
  --header 'Authorization: Bearer prvt_XXXXXXXX' \
  --header 'metadata: { XXXXX }' \
  --url 'XXXXX' \
  --data @- <<EOF
{
  "query":"query OperatorByID  {
  operatorByID {
    name {
      en
      es
      fr
    }
    shortDescription {
      en
      es
      fr
    }
    description {
      en
      fr
      es
    }
    contact {
      address {
        line1
        line2
        city
        subdivision
        postalCode
        country
        location {
          coordinates
        }
      }
      email
      phone
    ...
}

How the API is most often used

Most of our partners use the API to create custom profile pages. The Embeddable Operator widget gives the option of showing Operator details in a Slideout panel and/or linking directly to a profile page with a URL pattern you can customize. By passing the Whereabouts Operator ID in the route to that profile page, you can then use it to query the API and get the data you need to build and style the page. We have several clients who use this approach and we can share with you what we've learned to easily create high performance pages.

The Embeddable Operator Widget includes options for customizing a path to your profiles that match your template structure, including a human readable segment generated for you from the Operator's name. See this page for more information:

https://ttc.helpscoutdocs.com/article/82-embedding-widgets

All images are served via Cloudinary, so any additional sizing, cropping, or formatting requirements can be easily achieved by adjusting the image URL parameters.

An example of a profile page built using the Whereabouts API and custom image cropping: