Errors and rate limits
We're consistently improving and working on our APIs, to make them work for you. In order to make sure your customers get a seamless experience we have robust systems in place for caching, error monitoring and rate limits.
Errors
TTG Encore APIs employ conventional HTTP response codes to indicate the success or failure of an API request. In general:
- Codes in the 2xx range indicate success.
- Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
- Codes in the 5xx range indicate an error with TTG Encore's services (these are rare).
Some 4xx and 5xx errors can be handled programmatically (e.g., a ticket could not be reserved). We have a robust monitoring system in place that allows us to track error levels and work with partners to get fixes out quickly should there be issues.
Caching
The TTG Encore APIs employ standard HTTP cache control mechanisms. While requests are sent over SSL, your requests' responses cannot be stored on public intermediate proxy cache servers. However, if your application can potentially share the cache between different users, you have to be sure you only share responses marked as public in the Cache-Control HTTP header. This should be done automatically by your HTTP library if it respects the Vary HTTP header sent with private cacheable responses though.
The following caching headers should be observed for any custom caching logic:
| Property | Description |
|---|---|
| cache-control | The cache-control header indicates if the response is cacheable and for the duration. Clients should only cache public responses and for the max-age, indicated in seconds. Example: max-age=7200, public, s-maxage=7200 |
| x-cache | Indicates the response was returned from TTG Encore's internal caches. This header is for debugging purposes only. |
| x-client-request-datetime | Indicates the date and time the cached response was stored in TTG Encore's internal caches. This header is for debugging purposes only |
| x-ref-url | Indicates the normalised url used to generate TTG Encore's internal cache key. This header is for debugging purposes only. |
Further caching information can be found in the individual endpoint information.
Rate Limits
We enforce rate limits across all APIs.
Clients that have exceeded the maximum hourly or daily rate limit face their IP being blocked. Contact your Digital Partnerships contact for specific guidance around your circumstances.
Updated over 1 year ago