Each WebSocket connection counts as a single session. Sessions are authenticated using the OpenAuth 2.0 standard, with extensions for use with WebSockets.
For security reasons, all authentication that requires the Trading or Ordering scopes requires an SSL WebSocket connection. Zenith will not give out access to these scopes over an unsecured connection.
Clients should first authenticate with the appropriate Identity server. The exact steps for this process are documented in RFC6749.
You will need to have a Client ID and Secret registered for your application.
See Appendix A - Acceess Rights for the access rights your client can request from the Identity server.
Make your WebSocket connections to one of the Zenith servers.We highly recommend using a secured connection, as the API will require it for some operations (such as trading).
If you omit a version query parameter, you will receive whatever the latest data protocol is (which is distinct from the WebSocket protocol version).
Incoming requests should provide the User-Agent header with, at minimum, the Application ID and version information, as this makes answering support queries easier.
Example URL with data protocol version 2.0:
Zenith supports several authentication methods.
The OAuth Access Token can be provided during the initial WebSocket HTTP handshake. This is called the Bearer scheme, and is described in greater detail in RFC6750. Zenith supports the token being given in the Authorization header only – it does not support the form-encoding or URI methods.
GET /Zenith?version=2.0 HTTP/1.1 Host: apistaging.paritech.com Origin: * Upgrade: websocket Connection: Upgrade,Keep-Alive Sec-WebSocket-Key: 1234 Sec-WebSocket-Version: 13 Sec-WebSocket-Protocol: ZenithJson Sec-WebSocket-Extensions: permessage-deflate Authorization: Bearer mF_9.B5f-4.1JqM User-Agent: TestClient/1.0
Clients should regularly (every thirty seconds) send a WebSocket ping frame, and respond to any ping frames with a corresponding pong frame.
If the Access Token given by the OAuth server has an expiry date, you will eventually stop receiving data on a persistent connection. To prevent this from impacting the user, the client should reauthenticate with the OAuth server using the Refresh Token before the expiry date arrives.
Once you have a new Access Token, simply pass it on to Zenith by calling the AuthToken action.
Subscriptions will be remembered by the system when authentication expires, such as when the client does not reauthenticate in time.
When reauthenticating, any subscriptions that are no longer valid will return an error, followed by an unsubscribe notification from the server.