Introduction
Peppered offers 3 API's 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
- Peppered Activity: APIRESTful API for activity of visitors on the website
The benefits of these API's is that you, as a venue, will be in control of who has access to your data. We provided a new module for you to generate Keys yourself to hand out to all parties you want to give access.
Providing access keys to third parties
Each party that wants access to your Events feed, Stories feed or Activity API needs a secret Key. You can generate these keys yourself by clicking "Add" and hand them over to these parties.
You can also 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.
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 is either "Feed" for your events or stories, or "api platform" for the activity API.
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 Activity API.
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. Enter the key you just copied and select one of the feed options to view it.
- 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 manual.
- The other feed option "Agenda BE" are used by some of our clients. If you don't recognise this feed, you probably don't use it.
Information you need to send to a third party for the event feed
If the third party uses the POST-method
If the third party uses the GET-method
Information you need to send to a third party for the Activity API
All you have to do is send
- the URL of the API starting point (your website address followed by /api/ , like www.theater.com/api/ ),
- the Key,
- and the documentation (see below)
to the party that will need it.
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 pages