TickeTing Inc.
License
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.
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:
Start a session with a valid TickeTing username and password (this gives access based on the user's permissions).
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.
Omitting the X-API-Key Header from your request or specifying an empty value, will result in the following 401 error response.
{
"message": "Your request could not be authenticated."
}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.
{
"message": "You are restricted from accessing this resource."
}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.
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": "Please upgrade your client to complete this request"
}Requests to the API can result in a 404 error for two reasons:
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."
}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."
}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.
{
"message": "There was a server error while excuting this request. Please see system logs for details."
}https://docs.ticketingevents.com/_mock/openapi/
https://qa.ticketingevents.com/v3/
https://api.ticketingevents.com/v3/
https://docs.ticketingevents.com/_mock/openapi/orders
https://qa.ticketingevents.com/v3/orders
https://api.ticketingevents.com/v3/orders
curl -i -X GET \
'https://docs.ticketingevents.com/_mock/openapi/orders?item=string&number=string&page=1&profile=string&records=25&status=Placed' \
-H 'X-API-Key: YOUR_API_KEY_HERE'{ "page": 1, "records": 10, "entries": [ { … } ] }
Place a new order for one or more tickets. A single order can include multiple ticket types of a single event, or from multiple events. When a new order is created tickets are reserved for a fixed period of time until the order is settled, cancelled or times out.
If the tickets being ordered are free (i.e. the order total is $0.00), the order is fuliflled immediately and tickets delivered to the customer's account.
https://docs.ticketingevents.com/_mock/openapi/orders
https://qa.ticketingevents.com/v3/orders
https://api.ticketingevents.com/v3/orders
curl -i -X POST \
https://docs.ticketingevents.com/_mock/openapi/orders \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"items": {
"/events/16993717817996/sections/16993964783416": 2,
"/events/16993717817996/sections/16971671292759": 2
}
}'{ "self": "/orders/E8D946240203", "number": "E8D946240203", "status": "Placed", "placed": "2024-02-03T23:22:31+00:00", "subtotal": 140, "fees": 3.96, "total": 143.96, "items": [ { … }, { … } ], "account": { "self": "/accounts/MO-6A39EE8D", "number": "MO-6A39EE8D", "username": "mothers.milk", "email": "marvin.milk@usmc.gov", "role": "customer", "verified": false, "activated": true, "firstName": "Marvin", "lastName": "Milk", "title": "Mr", "dateOfBirth": "1974-09-14", "phone": "+1 (268) 555 0123", "country": "Antigua and Barbuda", "firstAddressLine": "Jennings New Extension", "secondAddressLine": "", "city": "Jennings", "state": "Saint Mary's" }, "payments": "/orders/E8D946240203/payments" }
https://docs.ticketingevents.com/_mock/openapi/orders/{order}
https://qa.ticketingevents.com/v3/orders/{order}
https://api.ticketingevents.com/v3/orders/{order}
curl -i -X GET \
'https://docs.ticketingevents.com/_mock/openapi/orders/{order}' \
-H 'X-API-Key: YOUR_API_KEY_HERE'{ "self": "/orders/E8D946240203", "number": "E8D946240203", "status": "Placed", "placed": "2024-02-03T23:22:31+00:00", "subtotal": 140, "fees": 3.96, "total": 143.96, "items": [ { … }, { … } ], "account": { "self": "/accounts/MO-6A39EE8D", "number": "MO-6A39EE8D", "username": "mothers.milk", "email": "marvin.milk@usmc.gov", "role": "customer", "verified": false, "activated": true, "firstName": "Marvin", "lastName": "Milk", "title": "Mr", "dateOfBirth": "1974-09-14", "phone": "+1 (268) 555 0123", "country": "Antigua and Barbuda", "firstAddressLine": "Jennings New Extension", "secondAddressLine": "", "city": "Jennings", "state": "Saint Mary's" }, "payments": "/orders/E8D946240203/payments" }