The current API is our third public version. It exposes a far greater range of functionality than either of our legacy APIs, while also being more user-friendly and with more comprehensive documentation. Newer integration options such as our Web Components are also built on top of API v.3.
Full documentation for API v.3 can be found at the following page
The above help page provides information for all available endpoints, as well as high-level information about authentication, supported call methods, and querying resources and sub-resources.
An important point to note is that API v.3 is available with three different modes, outlined below.
Web User / Public
This is designed to expose similar information to that found via Spektrix Iframes, e.g. event listings, prices, merchandise and so on.
As this information is all public, there is no need for authentication when using Web User mode.
It can also enable you to build baskets and create orders in the same way as you could via an Iframe - i.e. one customer at a time - via client-side site integrations.
It’s possible to share sessions between the API and the Iframe purchase path, allowing you to build bespoke booking paths that incorporate both elements.
It’s not currently possible to build a full end-to-end purchase path, as there are elements of payment processing and customer account management functionality that are yet to be exposed via the API.
This is specifically for access by third party agents who will be buying tickets from the system owner through a credit agreement.
This mode requires authentication for all calls, including GET calls used to retrieve e.g. event, pricing and availability information, which may change on a per-agent basis.
The system owner will provide access credentials for agents, who can each be set up with multiple customer records, each with different sales commission agreements, seat access and discounting where necessary.
Agents will need a separate e-mail address for each record held on a single system, and will be asked to provide a mobile phone number for 2 factor authentication purposes.
The Agent mode allows the creation, management and confirmation of multiple concurrent baskets, and provides full end-to-end purchase, with all transactions recorded against system credit logged against the specific API user’s account.
This enables full access to the entire system, including objects not available via the Iframes.
As this mode can expose sensitive customer data, it requires authentication.
It’s intended for use in server-side integrations created and managed by system owners and their appointed developers.