Communicating with the Interface

WebSockets are used to communicate with the Interface. Messages between the client and the Interface must be in JSON. Description of the JSON format can be found on the Command and Response Message Formats page.

The following describes a simplified interaction with the Interface, along with the response types of the messages received by a client:

• Open connection to Interface
• Connection accepted and initial snapshot of messages sent to client
  • INITIAL_UPDATE
• Send command message
• Requests sent to BuaBook API
  • REQUEST_SENT
• Response received from BuaBook API
  • RESPONSE if successful
  • RESPONSE_ERROR if failure
• Live updates from BuaBook API received throughout while WebSocket is open
  • UPDATE