Pressburst Developers

Pressburst is used by over 600 schools and we are always happy to work with web developers keen to integrate Pressburst news stories into their clients’ websites.

If you would like to arrange a conference call to discuss any aspects of integration with our development team, please do not hesitate to let us know – help@pressburst.com

Please refer to the API documentation for full details of all the available fields but please also note the following suggestions when developing your integration with Pressburst:

1. Caching

We strongly recommend caching content from Pressburst on a five or ten minute basis. You can cache both the text and images which your client has uploaded to Pressburst and use these to serve locally. Pressburst provides a realtime publishing environment so please highlight to your client the length of period for caching you are using, so they know when to expect changes to go live.

2. Facebook and Twitter

When a user tweets or shares a story from within Pressburst, a link to the story will be used to provide more detail for the post or tweet. This data is taken from the meta tags of the story detail page. The default page is hosted at https://pressburst.news/[organisation]/[headline]

If an organisation is using the Pressburst API and has configured it to link to the organisation’s own news pages then the following meta tags should be added:

<meta property=”og:site_name” content=”[site_name]”>
<meta property=”og:url” content=”[storyurl]”>
<meta property=”og:type” content=”article”>
<meta property=”og:title” content=”[headline]”>
<meta property=”og:description” content=”[standfirst]”>
<!– If the story has media (images) –>
<meta property=”og:image” content=”[mediaurl]”>
<meta name=”twitter:card” content=”summary_large_image”>
<meta name=”twitter:site” content=”[twitterusername]”>
<meta name=”twitter:title” content=”[headline]”>
<meta name=”twitter:description” content=”[standfirst]”>
<!– If the story has media (images) –>
<meta name=”twitter:image:src” content=”[mediaurl]”>
<meta name=”twitter:image:alt” content=”“>
<meta name=”twitter:domain” content=”[domain]”>

You will need to use the following fieldnames from the Pressburst API to populate the meta data above:

  • site_name: organisation
  • storyurl: url to story (not from API)
  • headline: headline – title/headline of story
  • standfirst: standfirst – summary/standfirst of story
  • mediaurl: first item in media array (e.g. media[0].filesslurl or media[0].sizes.default.filesslurl)
  • twitterusername: twitter username associated with the stories (not from API)
  • caption: caption of first item in media array (e.g. media[0].caption)
  • domain: domain on which site is hosted e.g. pressburst.news

3. Tags

When building your integration, you can take advantage of two ways of organising the content – categories and tags. Categories (API field: categories) are specified via the Settings in Pressburst and normally provide a top-down hierarchy for managing content. An example set of categories for a school could be: Academic | The Arts | Sport | Speakers & Visitors | Activities | Community. The full name is held in the fullcategories field and the short name in the categories field. So in the API, they would be returned as: academic, arts, sport, speakers, activities, community.

Tags (API field: tags) provide a flexible solution for marking stories and grouping them together. Individual sport stories could be tagged with the name of the sport. A page for Rowing, for example, could then pull in all stories with a tag of rowing and a category of Sport.

Categories and Tags can be used together to provide granular filtering or in isolation to ensure flexibility. For example, a school could tag all stories related to their 100 Year Anniversary with a tag of 100celebrations. Stories can be categorised when published as normal but a separate section of the website could pull in any story with a tag of 100celebrationsregardless of category.

Categories are fixed in Pressburst but because tags are flexible, schools need to ensure editors use them consistently throughout the publishing process.

If you have any questions or enhancement requests, please contact us.