Shiftex Web API

Overview

Shiftex has two base URLs, http://shiftex.vortexconnect.com/api and http://shiftex.vortexconnect.com/doc. The former is used as the base URL for the API calls. The later holds the documentation of such API.

The documentation is organized by resources. All resources are appended to the API base URL: http://shiftex.vortexconnect.com/api The data is formatted using JSON (Content-Type: application/json).

Authentication header

All request to Shiftex require a token in the request header called SessionId. That is used to keep the username and password secret and maintain a session.

Example of request:

GET http://shiftex.vortexconnect.com/api/shift/detailed/fe2996b2-5fb5-4977-9026-fbb11082edf3 HTTP/1.1
sessionId: G5yhZKX/Rd+ITbE2DNvy8LPph9b+NsL0SPRuVGUJJOs=

If there are problems with the headers the following error codes will be returned:

400 Bad Request: Missing SessionId header.
403 Forbidden: Session expired.
403 Forbidden: Invalid session id.

Versioning

Clients should always pass the version parameter in the Accept Header of the request to ensure the contract returned match the correct version. If no version is found or not Accept Header is specified the latest version of the contract will be used.

Example of request:

GET http://shiftex.vortexconnect.com/api/shift/detailed/fe2996b2-5fb5-4977-9026-fbb11082edf3 HTTP/1.1
Accept: application/json; version=2.0
sessionId: G5yhZKX/Rd+ITbE2DNvy8LPph9b+NsL0SPRuVGUJJOs=