Developer Documentation

Topics Covered

General Overview
Requirements
API Authentication
DropIn UI
Endpoints
Tracking
Ratelimiting
POST vs GET
Other limitations

General Overview

Welcome to the developer documentation page. This is the documentation for the API. if you have not yet applied for the API endpoint you can apply for the API here

Requirements

TLS 1.2 is the minimum requirement for all connections to our API and for companies and individuals using our API.
Data harvesting from the API will result in immediate termination of services. Do not do this.
you will need an API key in order to access certain endpoints
you will need to determine the type of integration you wish to accomplish before being granted access
tracking tokens must be on all API calls or you could lose access to our API
Heavy API use will incur rate limiting if you do not inform us about the traffic, be efficient with API calls
non-production should use the test API at the test domain.

API Authentication

We user JWT authentication for authenticating users with the API. Additionally, you will need to acquire a integration token from us if you are a business.

your headers should have the following in both POST and GET requests when authenticating users:

Content-Type:application/x-www-form-urlencoded
Authorization:JWT <jwt token>

you can get the JWT token by using this API endpoint and having the user login to our service: https://testing.tourzan.com/api/v1/rest-auth/login/

To authenticate with our api you will need your partner integration token as well. make sure its included with the url endpoint.

Example: https://testing.tourzan.com/api/v1/tours/?src=<token>

DropIn UI

our dropin ui is an iframe solution. to test what this might look like checkout this demo for guidesand this demo for tours
the drop in code for guides listings is: `<iframe src="https://api.tourzan.com/en/guides/"></iframe>`
the drop in code for the tours listing is: `<iframe src="https://api.tourzan.com/en/tours/"></iframe>`

Endpoints

The API's are self documenting. following the endpoints will bring you to a list of all the endpoints available:
Our testing endpoints are https://testing.tourzan.com/api/v1/
Our api production endpoints are https://api.tourzan.com/api/v1/
Api self documentation https://api.tourzan.com/api/v1/docs/

Tracking

We track our partners referrals with the following tag at the end of the url
`?src=<token>`
Please make sure you have this or you will not get your share for orders that are processed with us and will be rate limited.

Ratelimiting

Rate limits are currently set to 3 requests per second. I know this looks like its a huge inconvenience but here's the scoop, if you do not apply to use the API then you don't get to play with the API in the same way as those who asked to use it. Please make sure you are using and implementing our API appropriately.

POST vs GET

in the API endpoints they state what kind of calls can be made. POST is for certain types of calls and GET for others. We do specify the type of requests and serialization that can be handled on our platform. to prevent having a hard time please make sure you checkout the self documentation and reach out to us if you have any issues with implementing the REST API.

Other limitations

We have seen some cool stuff done with our API such as guide ratings, tours overviews and even our own mobile app but just like all new cool things we do not have a solution yet for everything. please reach out and request functionality to the API if you can't find the functionality to something you need.

Developer Documentation

Topics Covered

Feedback for tourist