Your Peppered platform offers 2 Feeds for third parties to access your data:
- Peppered Stories: APIJSON feed of all relevant stories on your website
- Peppered Events: APIJSON feed of all relevant events on your website
Your Peppered platform also comes with a RESTful API which offers endpoints for
- productions
- events
- halls
- spaces
- locations
- genres
- prices
- event statuses
- event images
The benefits of these feeds & ther API is that you, as a venue, will be in control of who has access to your data. Go to System > API Access Keys to generate Keys yourself to share with all parties you want to give access.
Providing Access Keys to Third Parties
Each party that wants access to your API, Events feed or Stories feed needs a secret Key. You can generate these keys yourself by clicking "Add" in the API Access Keys module and sharing them with these parties.
The following screen will appear:
Fill in the name of the party that will use the key. Although in theory multiple parties could use the same 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.
The Key Type should be "Feed" for your events or stories feed, or type “apiplatform” for API access.
Optionally fill in an expiration date if you want to provide access for a limited time only.
Repeat this process for all parties that need access to your Events or Stories feeds or API
Removing API Access
You can Retract a key once the party is no longer using your feed, or you don't want them to use your feed anymore. If the secret key was forgotten or lost, use the "refresh" icon to obtain a new key for a particular feed.
Obtaining the URL of an event feed
After having added and copied a new key for the feed, you can now generate previews of different feeds. Select one of the feed options to view it, enter the key you just copied and click “run test”.
The url of the feed can be copied from the browser window in which the feed is opened.
Copy the feed url and send it together with the access key to any partner you want to give access to your feed.
- The feed "Events (JSON)" is a completely new feed which will offer a lot more features and data, including real time availability. It looks like this (when using a suitable JSON viewer):
- The Facebook stream, Facebook and Google feeds can be used to import your events to these platforms for advertising. Only events or productions with the "enable remarketing" checked will be included in these feeds. More information in the Productions article.
- The other feed option "Agenda BE" is used by some of our clients. If you don't recognise this feed, you probably don't use it.
Obtaining the URL of the API
The API can be found on your own web domain, followed by /api/docs
So for example if your domain is www.thebestvenue.com, the api can be found at www.thebestvenue.com/api/docs
Send this url and the API access key to any partner that needs it.
Extra information you need to send to a third party for the event feed
If the third party uses your feed via the POST-method
All you have to do is send
- the URL of the feed (you can copy that url from the "run test" preview window),
- The Key you generated,
- and the documentation (see below)
to the party that will need it.
If the third party uses your feed via the GET-method
Send the URL of the feed, and place the api-key you generated in the URL directly.
- For the JSON feed it should look like this (this is a fictional example): https://www.theater.nl/nl/feed/events?apikey=123abc456. (Instead of 123abc456 you should enter the api key.)
If the third party uses your REST API endpoints
All you have to do is send
- the URL of the API,
- And the Key you generated
Documentation for third parties
Documentation on how to connect to your events or stories feed or Activity API is available for all third parties. You can share this PDF with anyone you want. Make sure you also provide a Key so they can access your data.
Related articles