Our APIs?

General Information

Our API is served over HTTPS from a common sub-domain (tixuk.io), on the following endpoints:

Authentication

Most of our endpoints are public and don't require authentication (and authorization) - given they share data that exists in the public domain. Authentication is only required for sensitive endpoints which change state (i.e. create, delete or modify data). Any endpoints that require authentication (and authorization) are indicated as such in the API reference documentation.

Each API call requires standard headers affiliateId or x-tt-retailer which will allow you to access responses tailored to you. Talk to your account manager or follow the contact-us link to request this id.

JWT Authentication

Some endpoints on certain services require JWT authentication. To authenticate, you must first obtain a JWT by calling the /api/login endpoint of the service with your username and password. Below is an example of how to do this using cURL:

curl --location --request GET 'https://some-service.tixuk.io/api/login' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "username": "someusername",
    "password": "somepassword"
}'

Using the JWT

Once you receive the JWT, include it in the Authorization header of your requests to endpoints that require it.

API semantics

All of our APIs conform to the REST architectural style and all responses are sent back to you in JSON, a lightweight data interchange format. Responses are returned in two kinds of structure: item and list.

Items

Items are JSON objects consisting of unordered attributes–value pairs, with at least a top-level of pairs (some can contain nested objects). Curly brackets delimit them. This kind of response is used when a single object is requested. The properties are the requested field names and their corresponding values.

{
    id: 1587,
    name: "Wicked",
    type: "show",
    venue: {
        id: 138
    },
    onSale: "yes",
    bookingStarts: "2018-08-07T00:00:00+0000",
    bookingEnds: "2019-05-25T00:00:00+0000"
}

Lists

The list response type is a JSON object containing a list property. The associated value is a JSON array of items. Some other properties should be returned, like other APIs, but we've not developed this.

{
    "results": [
        {
            id: 1587,
            name: "Wicked",
            type: "show",
            venue: {
                id: 138
            },
            onSale: "yes",
            bookingStarts: "2018-08-07T00:00:00+0000",
            bookingEnds: "2019-05-25T00:00:00+0000"
        },
        {
            id: 1587,
            name: "Wicked",
            type: "show",
            venue: {
                id: 138
            },
            onSale: "yes",
            bookingStarts: "2018-08-07T00:00:00+0000",
            bookingEnds: "2019-05-25T00:00:00+0000"
        }]
}

Pagination

Many of our APIs allow paging through list endpoints in a standard way. Each endpoint support for paging is outlined in the relevant API reference as you work through it. Here's a summary below.