OMS WebSocket API Usage
Connecting
Section titled “Connecting”Connect to the OMS hub via HTTP at ws://oms.hub/streaming.
Authenticating
Section titled “Authenticating”The WebSocket API requires an access token issued by a registered OAuth Server, with the appropriate Audience for the OMS service.
Messaging
Section titled “Messaging”Each connection has a Message Type, which is set by the most recent message sent to the server.
If sending a Binary WebSocket packet, the server expects, and will respond with, binary-serialised Protobuf.
If sending a Text WebSocket packet, the server expects, and will respond with, JSON-serialised Protobuf.
The client can change the Message Type by sending a new message with a different type.
Serialisation and Deserialisation
Section titled “Serialisation and Deserialisation”Each Binary message should contain a single binary-serialised Protobuf message.
Each Text message should contain a single JSON-serialised Protobuf message.
See JSON Data Types for specific notes on JSON serialisation.