Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| developers:websocket:connecting [2025/03/14 02:53] – created chad | developers:websocket:connecting [2026/03/09 16:39] (current) – [Authentication] frank | ||
|---|---|---|---|
| Line 5: | Line 5: | ||
| ===== WebSocket Connection ===== | ===== WebSocket Connection ===== | ||
| - | ^ Environment ^ WebSocket URL ^ | + | <WRAP 50%> |
| - | | **Live** | `wss:// | + | ^ **Environment** ^ **WebSocket URL** ^ |
| - | | **Simulator** | `wss:// | + | | **Live** | %%wss:// |
| + | | **Simulator** | %%wss:// | ||
| + | </ | ||
| + | |||
| + | |||
| Clients must connect using **WebSocket Secure (WSS) over SSL/TLS** on port **443**. Messages are encoded using **Google Protocol Buffers (Protobuf)**. | Clients must connect using **WebSocket Secure (WSS) over SSL/TLS** on port **443**. Messages are encoded using **Google Protocol Buffers (Protobuf)**. | ||
| Line 15: | Line 20: | ||
| ===== Authentication ===== | ===== Authentication ===== | ||
| Authentication must be performed **immediately after establishing a connection** by sending a `LoginRequest` message. This API supports two authentication methods: | Authentication must be performed **immediately after establishing a connection** by sending a `LoginRequest` message. This API supports two authentication methods: | ||
| - | - **API Key Authentication** (provide only the `api_key` field). | + | - **API Key Authentication** (provide only the `apikey` field). |
| - | - **Username/ | + | - **Username/ |
| **Example LoginRequest (API Key Authentication): | **Example LoginRequest (API Key Authentication): | ||
| < | < | ||
| { | { | ||
| - | "api_key": " | + | "apiKey": " |
| } | } | ||
| </ | </ | ||
| Line 31: | Line 36: | ||
| " | " | ||
| " | " | ||
| - | "app_name": " | + | "appName": " |
| - | "app_license": " | + | "appLicense": " |
| } | } | ||
| </ | </ | ||
| Line 42: | Line 47: | ||
| { | { | ||
| " | " | ||
| - | "session_id": " | + | "sessionId": " |
| - | "user_id": " | + | "userId": " |
| - | "firm_id": " | + | "firmId": " |
| " | " | ||
| } | } | ||