eHUB API Design

RESTful Design

The eHUB API is a REST API over HTTP. RESTful applications are designed to work the way the web works, using HTTP verbs (GET, POST, PUT and DELETE) to operate on resources. However, it doesn't use hyperlinks (i.e. embedded links within the returned response), but instead it's up to the developer to get possible necessary information from a previous response when creating a request.

Authentication

The eHUB API uses the standard HTTP Authorization header for authentication. Therefore the Authorization header is required in all eHUB API requests. See the Security page for more information.

Versioning

To support future changes, a version number is included in the URL paths for eHUB APIs. It is also possible that the body of the requests and responses may vary between the different versions.

Response Format

Currently, JSON is the only supported response format.

Encoding

All API responses are UTF-8 encoded.