The IBM® MashupHub application programming interface (API) provides services for using the catalog and adding plug-in extensions to the MashupHub server. The catalog-related services are all Representational State Transfer (REST) services based on the Atom Syndication Format and the Atom Publishing Protocol.
The API provides these catalog services:
- A service for searching the catalog
- A service for adding new items to the catalog and for reading, updating and deleting those items
- A service for collecting metrics on feed, widget, page, space and widget template usage
MashupHub also provides a plug-in mechanism for adding extensions for the support of new content types and new feed data sources. For new feed data sources, developers can provide plug-in classes written in the Java™ language for Editor plug-in components that provide a user interface for defining the contents of a feed, Generator plug-in components, that generate Atom or RSS feeds from particular data sources, and Collection plug-in components, that provide search and catalog API support.
MashupHub can generate feeds from a number of data sources and it can support upload, download and other operations for widgets, mashup pages, mashup spaces, and widget templates. The feed generation for each type of data source is provided by a plug-in that is included as part of MashupHub. It also includes plug-ins for iWidgets (in several packaging options), generic widgets, mashup pages and mashup spaces. In the descriptions in this reference, all plug-ins, those provided by MashupHub and those added by third parties, are treated the same. Rather than refer to a data source or widget type, the descriptions refer to the plug-ins that support them.