Rest Connector

REST Connector is a publishing server plug-in to connect publishing hub to arbitrary HTTP based RESTFul services. REST Connector acts as a restful client to the target REST API using URIs that can be configured in a configuration file. Query results will be filtered and mapped into publishing hub entity data objects using XPath or similar expressions.

If you are new to RestConnector configuration please have a look at our new tutorial Working example: Accessing wordpress.com.

If you are just interested in latest additions or fixes, please see Change log.

Since priint:suite 2024.2 (4.5) the REST Connector is part of the standard delivery.

License (since 4.1.9)

The usage of the RESTConnector requires a license. Please make sure to check if your PubServer already supports the right amount of RestConnector connections in the Admin panel (your-pubserver/Admin/license)

For more information on licensing your connector see this article.

If you are using your RestConnector unlicensed or with the wrong amount of data sources the output of the RestConnector will be replaced with XXX.

Make sure to license your RestConnector data sources.

Concepts

• Process flow within the connector
• Connector entity identifier
• Request context
• HTTP processing
• XML processing
• JSON processing
• Error handling
• Hints for debugging

Configuration

• Install or Update RestConnector
• Creating configurations files and defining instances
• Main Elements
  • <rest-connector>
  • <connection>
  • <authentication>
  • <cache>
  • <entity>
  • <query>
  • <paging>
  • <sort>
  • <mapping>
  • <language> and <country>
  • <param>
• Other elements and enumerations
  • <error-mode/>
  • query input enum
  • query types enum

How-to

• Secure connection - HTTPS
• HATEOAS Queries
• Custom Domain Models and JAXB Processing
• Processing of TableData
• Reading XML or JSON files from local file system
• Using POST instead of GET
• Mapping media assets and media objects
• Mapping metaData
• Using the searchStr parameter
• Save data to service
• Using entity references
• Query chaining
• Download Media Resources with Proxy

Examples

• Worked out example: Accessing wordpress.com.
• Simplistic configuration
• Full configuration example with detailed explanations
• Configuring a recursive root entity from one big flat file
• How to use a fully dynamic URI
• Configuring cords
• Configuring a recursive root with parentId parameter

Appendix

• Supported Connector Methods
• Supported Entity Fields
• Supported XPath Functions
• XML Schema for configuration
• EasyRest migration guide
• Change log