Follow

What is needed to integrate your XML or JSON feed

Below is details on what we need to integrate your feed with Pugpig Express, this work is typically covered by Kaldor under a Pugpig Feed Handler Pack. 

Before integration work can begin we need:

  • Access to an XML or JSON feed at a specified URL. If this URL is secured by IP address or Basic Authentication we can provide our IP range.
  • Your feed needs to meet a minimum set of requirements:
    • You must provide a unique ID for each story in your feed. If an ID is used more than once we will treat it as an update to the original story, not as a new story.
    • You must provide the last updated date on each story in your feed so we know which articles have changed since we last processed.

The following is supported under our Feed Handler pack.

  • We only support basic import to an Article content type, other content types (Shorts, Full Page Images, Content Pages) can be manually created post import. Customisation beyond this Feed Handler pack is possible but may include additional cost. 
  • We support all the common inline style tags including headings, bold, strong, italics, emphasized, subscript and superscript text. 
  • We support inline images, these need to be directly in the body or with a reference to the image in the body. For the latter we would still need a link to the image. We also support a main media image or table of contents image and can specify overrides for these or agree default inheritance rules.
  • When a story has been imported and processed, you will be able to manually edit in Pugpig Express with our easy to use Wordpress interface. However, updates to this story via the feed will override any manual changes. 
  • We can order the content by date or section if provided in the feed, alternatively you can manually order your content post import.
  • Our system will automatically poll the feed for content updates at regular intervals, we can agree with you a sensible poll period for your publishing frequency and we currently cap the polling at a maximum of every 15 minutes.
  • For edition-based publications we need some reference to the edition articles should be in. Once content has been imported and processed you will need to manually add some edition metadata, this typically involves uploading an edition cover image, depending on what we can retrieve from feed it may also include some article re-ordering (via a drag and drop flatplan tool) and configuring whether edition is Paid or Free. This should require only a small amount of manual effort (less than 1 hour) to complete.
  • For testing purposes ideally we get access to a secondary feed which can have full sets of content examples available at all times and be updated at request. When testing we can quickly run out of content updates because we are regularly polling the feeds.

Customisation beyond this can be accommodated but will be discussed on a case by case basis and may have additional costs to integrate.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk