Introduction

The TickeTing REST API v3 allows developers to integrate with the TickeTing platform, from creating hosts and events to buying and transferring tickets. This reference document will walk you through authenticating against the API and the full list of available endpoints, their permissions and functionality.

Authentication

The TickeTing API uses API keys to authenticate requests. You must provide a valid API Key in the X-API-Key header of each request you make. There are two ways to get a valid API Key:

1. Start a session with a valid TickeTing username and password (this gives access based on the user's permissions).

2. Secure an integration key from a system administrator. Integration keys grant an access level determined by the administrator on creation.

Session Authentication and Integration Keys are covered in the Authentication section of this reference.

Example Request Header

Authentication Errors

Omitting the X-API-Key Header from your request or specifying an empty value, will result in the following 401 error response.

If an invalid X-API-Key value is provided, or the provided key is valid, but does not have permission to access the requested resource, the following 403 error response is sent.

Client Version

All requests to the API must advertise the version of the API they wish to integrate with. This ensures compatability with the server. This is done by including the X-Client-Version header in every request along with the expected API version. In this way the server can indicate when a client must upgrade to avoid breaking changes.

Example Request Header

Client Version Errors

If the X-Client-Version header is omitted from your request, or the provided version does not meet the minimum required by the API, the following 412 error response is sent.

Error Responses

404 Errors

Requests to the API can result in a 404 error for two reasons:

1. The endpoint you are trying to access does not exist, in which case you will see the following response:

   {
       "message": "The requested endpoint /invalid/endpoint does not exist on this server."
   }

2. The endpoint you are requesting exists, but a resource cannot be located using the given URI. For example, trying to access an event resource with a non-existant ID such as /events/0000000 will result in the following response:

   {
       "error": "There is presently no resource with the given URI."
   }

Server Errors

This version of the API is still under development and there may be bugs and runtime errors encountered while processing your request. In these cases, a 500 error response will be sent with the message below. If such a message is received, please contact a system administrator with the details of your request (endpoint, method, headers and payload), so they may reproduce and resolve the issue.

Other Errors

Additional error responses may be received when incorrectly accessing valid API endpoints. The errors received, and their resolution, are specific to the requested URI and HTTP Method and details are provided with each endpoint's reference where applicable.