Public
Documentation Settings
Select option
Double Column
Select option
REST API
Introduction
User Authentication
Users
Admin Authentication
Admins

REST API

Welcome to our REST API documentation! On this page you will find details about the endpoints, parameters, headers and example responses.

To try out some API requests please visit our Swagger page via the following URL: https://api.easysecure.cloud/swagger

All the REST API calls must have the following header:
accept: application/json

All the REST API calls that are POST requests must have the following header:
Content-Type: application/json

Multi-language support is available for textual responses (where it's the case, mostly these are error messages), currently supported: EN, NL, DE. Based on the supplied Accept-Language header from the API call we decide which language the client prefers, default is EN. Example: Accept-Languag: en-US,en;q=0.9

All the error responses returned to the client application are in the format:
{
"message": "",
"url": "",
"code": “”
}

  • message – is a textual description of the error itself;

  • url – the endpoint where the error was triggered;

  • code – the HTTP response code which is also available in the response header;

For authentication please make sure the correct POST method is used.

User This method is used when FireBase user invite is send via the user menu.
Admin This method is used when FireBase user invite is send via the Administrator menu

Note**: in the endpoints from this collection, request body values are example values;

Loading