Virola Web API

Current version of Web API is a very basic one as we decided to start publishing it as soon as we get the first working request.

At the moment Web API calls can be made with curl command only. We are working on making calls from browsers possible, on improving response data, and on adding new requests.

Web API access token is required to send Web API requests.

To get a Web API token, use main menu Tools -> Web API Access Token

The token will tie your user profile with Web API calls you make, so all calls will be performed on your behalf.

Note! Once you generate a new token, your previously generated token will stop working.

Chat room ID is required to send chat messages.

To get the chat room ID, right click the room in the room list and check its number at the top of the opened context menu.

Web API Requests

Get server health information

                curl -k -X GET \
                    -H "Authorization: Bearer TOKEN" \
                    https://HOST:PORT/api/v1/server-health

Send a text message into the room

                curl -k -X POST \
                    -H "Authorization: Bearer TOKEN" \
                    https://HOST:PORT/api/v1/rooms/ROOM_ID/text-messages \
                    -d "{\"content\":\"Hello, World\"}"