Easy web services with eZ Publish

One of the things I love about eZ publish is that it's so configurable and often settings can be used in ways that were not thought of when introduced.

In version 3.8 the ability to add and override HTTP headers was introduced (from what I can tell to allow for fine tuning of cache related headers).

In the most basic terms a web service is the ability to provide machine readable data (typically XML) over a network.

eZ publish has the ability to provide RSS feeds which is contained within it's own module. However this is quite limited. eZ also come with a SOAP library that would allow the coding of services.

The introduction of the httpd header overwrite feature allows for eZ Publish to use the templating system and the content within the site to produce any data you require, i.e. no php coding required. It also allows for the data feeds to be dynamic and relative to the existing web content.

The process in a nutshell is:
  • create a layout for the webservice (layout.ini)
  • overwrite the "Content-Type" header for this layout so that the ouput is presented as XML (site.ini)
  • create templates to produce the desired output
I'm working on a site that uses this method to produce podcasts and will post some code examples once the site is complete.

Tags:

Comments

  1. Anonymous6:24 pm, March 13, 2008

    Hi Bruce,

    I'm very interested for some example about podcast.
    It's cool if you share this.

    Cheers.

    Stephane.

    ReplyDelete
  2. Unknown9:53 am, April 22, 2008

    Hey Bruce,

    I'd also be interested in seeing some example code for this. I"m doing an ezPublish implemenation now where we'll be outputting object data in XML format to then be styled with XSLT via another webservice.

    ReplyDelete

Post a Comment

Popular posts from this blog

eZ Publish Admin Prototype extension

Following on from yesterdays post on checking out the eZ Admin Interface prototype I've created an extension that can be easily downloaded, installed and enabled. Download the extension from here Copy to your extension directory and untar: tar xzf admin2prototype.tgz Enable it in your admin siteaccess by editing settings/siteaccess/site_admin/site.ini.append.php and adding: [ExtensionSettings] ActiveAccessExtensions[]=admin2prototype Clear the cache To disable, simply remove the settings from step 3 above and clear the cache. Note: If you enable the extension via the admin interface (Setup -> Extensions) this will effect all site accesses including your front end ones.  Things to check out in the prototype: Lack of Shop and Design tabs - these are disabled by default in eZ Publish 4.3 Hidden right menu. Click on the [+] to expand Content menu (Left Hand side under Content, Users & Media Tabs) can be variably sized. Grab the bottom right hand corner an
Read more

eZ Publish Admin redesign - Dashboard = OpenSocial?

Image
In the preface to the current Admin interface specification the last paragraph caught my eye: A overview of user task need a dashboard , where she can follow here own content, approval and other tasks she might do on a regular basis. I recently saw a demo of the latest version of the bug tracking system JIRA 4.0 by Atlassian . It used an OpenSocial dashboard to allow users to customise their homepage to access and interact with information that was important to them.  The system not only displays JIRA widgets but any OpenSocial widgets (and those from other Atlassian products ). You can check out a video of it in action here and more information on how Atlassian is using OpenSocial here . What is OpenSocial? From the official site: OpenSocial defines a common API for social applications across multiple websites. With standard JavaScript and HTML, developers can create apps that access a social network's friends and update feeds. Google personal home page is an example o
Read more

eZ Publish 5 Virtual Machine

One of the most common issues of newcomers to eZ Publish is the setup of a system suitable for running it. Without a correctly configured system in place they usually do not get beyond the installation process and abandon their evaluation before having experienced the product.  The eZ Publish puppet module is an attempt to codify the requirements  for running eZ Publish and provide a means for automatically creating a system suitable for running it - no more following a checklist of "setting up eZ Publish on XYZ". The eZ Publish 5 Virtual Machine can be found on github at  https://github.com/brucem/vagrant-puppet-ezpublish .   It combines Vagrant, VirtualBox & Puppet to generate a VM with the current eZ Publish community version (2013.4) installed and ready to be configured. The README.md  provides details of the requirements and how to use it. Vagrant is a system that  orchestrates the automatic creation and configuration of systems. It has been used to d
Read more