Authentication

The O3 Room REST API uses HTTP Basic Authentication as a means of interacting with the API endpoints.

This authentication is constructed from an enteliWEB username and password, which are created by the administrator of the enteliWEB server. This user account must have read and write permissions to the BACnet objects that monitor and control the room, and added as a member of the O3 Room Guests user group in enteliWEB.

CSRF Token and Session ID Cookie

The CSRF token and enteliWEB session ID cookie are generated when you make this GET request:

https://{enteliWEB Server IP Address}/enteliweb/api/auth/basiclogin

The enteliWEB username and password should be encoded and included in the request header.

Request Path Parameters

Name	Description
{enteliWEB Server IP Address}	The IP address of the enteliWEB server in the O3 room network.

Response

This GET request returns _csrfToken and the enteliWEB session ID cookie which is saved in the API client.

• In the response header, the enteliWEB session ID cookie is displayed as the enteliWebID key. This cookie is required for all GET and PUT requests, and has an expiry period which you can set in your enteliWEB user account settings. The default expiry period is 20 minutes. The session timeout timer resets every time the user interacts with the application.

  When the session expires, the application needs to re-authenticate which generates a new enteliWebID.

  

• The _csrfToken must be passed as the Authorization header for all PUT requests.

© 2019 Delta Controls O3 Room REST API Version 1.0