Access Keys for RESTful API, Events Feed, AI feed and Stories feed

1. Stories: JSON feed of all visible stories on your website

2. Events: JSON feed of all future visible events on your website

3. AI: TXT feed of all future visible events and visible pages/stories with the box “include in AI feed” checked. This feed can be used to serve your data to any third party AI chat bot on your website.

• Productions & events

• Anonymised CRM & Ticket sales

• Full CRM & Ticket sales (coming soon)

About the RESTful API

• Example use cases:
• Spot which postcodes buy the most tickets and target your marketing accordingly.
• See which age groups prefer matinees versus evening shows.
• Compare your sales patterns against sector benchmarks.

Providing Access Keys to Third Parties

• Select Add in the API Access Keys module

• The Access Keys screen will appear:

• Add the Name of the party that will use the key. It is advised to generate different keys for different parties, so you can see who has access, and you can change this for each party if needed.

• Key Type:
• For AI, Events or Stories feed select feed
• For API access select api platform

• Expiration: Option to add an expiration date if you want to provide access for a limited time only. Optional field.

• Access restricted resources:
• After saving the new key, you can manage access to restricted resources. This feature only applies to keys with the type “API platform” and can be used to block or grant access to sensitive data like your CRM API endpoints ( these endpoints will be released soon).
• To grant access, check the box “Access restricted resources” and select which resources you want to include from the select box. currently the only option is the /crm endpoints.
• Click save. This API key now has access to all API endpoints, including the /crm endpoints

Removing API Access

How to get the URL of a feed (JSON)

• Select one of the feed options to view it, enter the key you just copied and click Run test.

• The Events (JSON) feed includes a lot of Production and Event data, including real time availability. It looks like this (when using a suitable JSON viewer):

• The Stories (JSON) feed includes all visible stories and pages

• The AI (TXT) feed includes a written summary of all events and a selection of stories with the option “Include in AI feed” checked in the Dashboard.

• The Meta stream, Meta and Google feeds can be used to import your events to these platforms for advertising.
🚧
Take note! Only events or productions with the "enable remarketing" checked will be included in the Meta & Google feeds. More information in the Productions article.

How to make a request to a feed (JSON)

Endpoint

Language

• Adding language to the url will change the return language for the whole feed.

• If no language is provided the default one will be used, which generally is dutch.

• If an nonexistent language is provided, a 404 page will be shown.

Methods

Authorization

Body

Response

{
	http_code: 403,
	status: "Forbidden",
}

{
	http_code: 400,
	status: "When parameter 'past' is provided, the parameter 'startDate' must also be provided.",
}

{
	http_code: 500,
	status: "{error_message}",
}

Image URL’s

How to get the URL of the API

Extra information you need to send to a third party

How to make a request to the XML/CSV SEA Feeds (Google, Meta)

Endpoints

Methods

Authorization

Response

<?xml version="1.0"?>
<result>
	<http_code>403</http_code>
	<status>Forbidden</status>
</result>

<?xml version="1.0"?>
<result>
	<http_code>500</http_code>
	<status>{error_message}</status>
</result>