Welcome!

Hideez Enterprise Server web API

How to form Hideez Enterprise Server API requests
Written by Denys Beztuzhev
Updated 2 months ago

The HES web API is intended to integrate the Hideez Enterprise Solution with the third party services.

Using the API you can manage employees, devices, and credentials. Almost everything you can do with the HES web interface you can do via the HES REST API calls.

To see the list of available methods, their parameters and return values you need to install your own HES instance and open the link:

https://<your_server_name>/swagger/

By this link, you will be able to test each method as well.

To use web API calls from an external application or service you need to authorize first. Use POST method https://<your_server_name>/api/Identity/Login and send your login (email) and password in the json format:

{
"email": "<user_email>",
"password": "<user_password>"
}

Server response headers will contain cookie named '.AspNetCore.Identity.Application'.

Add this cookie to the headers of each following request.
Identity cookie is valid for two weeks -  after that you need to call the https://<your_server_name>/api/Identity/Login method again.

Did this answer your question?