API Design

General Request/Response Instructions

Request

Each request must include the following headers:

Accept: application/json
Content-Type: application/json

Response

Responses will always be sent with the Content-Type: application/json header and will always contain a json formatted body if the response contains a body.

For the specific status codes used for API's, please refer to the documentation of the Stepup-Gateway and Stepup-Middleware.

Datetime Formatting

Dates/Times are always formatted according to ISO 8601. Currently only the full date and time is being used: 2014-09-25T15:44:49+02:00

Example implementation:

$dateTime = (new \DateTime())->format('Y-m-d\\TH:i:sP');
echo $dateTime; //output: 2014-09-25T15:44:49+02:00
$reinstated = DateTime::createFromFormat('Y-m-d\\TH:i:sP', $dateTime);

Security

All API's are secured using Basic Access Authentication as all API calls are internal in the trusted network. Valid API clients can be configured in the various app/config/security.yml files of the applications.