1. RESTful Apis  

The Integration Hub supports access to services in a number of different formats and protocols including “RESTful” web services. Put simply, these APIs allow access to services using standard HTTP protocols to execute various operations in order to submit data (such as a new Order), or to query data.

1.1.    Key Features

There is no prescribed standard for REST based web services however the APIs offered through the Integration Hub follow standard industry practise. The APIs are designed to be flexible for use with a number of different languages and data formats. The key features of the APIs are:

• End to End security is provided by using SSL to encrypt all communications with the Integration Hub
• Authentication is provided by use of a ‘token’ value – a secure value generated using the Integration Hub.
• Data is offered in a number of different formats (these vary from service to service)

o XML o JSON o CSV o HTML

• The services incorporate a ‘version’ identifier so that new versions of the API can be offered without requiring existing clients to upgrade immediately.

1.2.   Corresponding Documentation

To avoid duplication this document should be read in conjunction with the SupplyStream WCF Services document. The WCF document provided detailed information on the attributes associated with each messages and the specific SupplyStream error messages returned.