API

A set of APIs are available to manage ERS and allow the actual generation and deletion of tokens and rooms. These APIs are accessible through an HTTP GET request with the following format:

http(s)://<ERS IP>:<ERS adminPort>/?c=<commandName>&i=<Id>

Where:

For example, an ERS running on the same machine where the request is being generated from (default setup) can use the following:

http://127.0.0.1:3030/?c=addToken&i=thisIsASampleToken

This HTTP GET request can be sent through any scripting language desired.

An example admin interface which uses Javascript to send out this request can be accessed through:

http://127.0.0.1:3030/ersadmin.html

Get Version

Returns the current version of ERS.

Example:

http://127.0.0.1:3030/?c=version

Add Token

Adds a token that can be used later by a client trying to connect with EMS.

Example:

http://127.0.0.1:3030/?c=addToken&i=tokenId

Delete Token

Deletes an existing token.

Example:

http://127.0.0.1:3030/?c=delToken&i=tokenId

List Tokens

Displays all created tokens currently active.

Example:

http://127.0.0.1:3030/?c=listTokens

Add Room

Adds an allowed room to the list during runtime. This command also effectively prevents creation of rooms not included on the list.

Example:

http://127.0.0.1:3030/?c=addRoom&i=roomId

Delete Room

Deletes a room added from the list.

Example:

http://127.0.0.1:3030/?c=delRoom&i=roomId

List Rooms

Displays all rooms with their corresponding descriptions and status.

Example:

http://127.0.0.1:3030/?c=listRooms