Register API Request

Field	Details
API Name	RegisterAPIRequest
URL Format	<protocol>://<domain name>/<VirtualDir>/<URL>
Example URL	https://localhost:8080/OTPA/V1/RegisterAPIRequest
Description	This API is used by the client to create a session with the system. The trading engine authenticates and validates the request, then returns a response message.
Token Requirement	The request must include jToken received from the Authentication API response.

📥 Register API Request Parameters

The Register API request contains the following parameters:

Parameter	Data Type	Mandatory / Optional	Description
jRequestID	varchar(255)	M	Echo‑back field
jToken	varchar(512)	M	Authentication token received in the Authentication API response
jConnMode	int	M	Determines response mode: 1 = Response via webhook 2 = Response via WebSocket
jURL	varchar(512)	O	Webhook URL (mandatory only if jConnMode = 1)

Example Request

{
  "jRequestID": "<ServerID>",
  "jToken": "<Token>",
  "jConnMode": "<response_mode>",
  "jURL": "<Web hook URL>"
}

---

📘 Register API Response Parameters

The ResponseObject contains the following parameters:

Parameter (Key)	Data Type	Description
jRequestID	varchar(255)	Echo‑back field returned from the request
jResponseID	varchar(255)	System‑generated alphanumeric response ID
jWebSocketDetail	varchar(512)	Contains WebSocket connection details when registration mode is WebSocket. Format: <ws/wss>://<domain/IP>:<port>
jStatusCode	int	1 = Success, -1 = Failure
jHeartbeatIntervalInSecs	int	Time interval (in seconds) after which the system sends a HeartBeatPacket if no other messages are available
jErrorString	varchar(512)	Free‑flowing error message (present only on failure)

Example Response

{
  "jRequestID": "<ServerID>",
  "jResponseID": "<response_id>",
  "jWebSocketDetail": "<ws/wss>://<domain or IP>:<port>",
  "jStatusCode": 1,
  "jHeartbeatIntervalInSecs": "<TimeInterval>",
  "jErrorString": "<Free Flowing Error Message>"
}

---

📡 Logon Request for Web Socket

Field	Details
API Name	LoginToWebSocket
URL Format	<protocol>://<domain name:port>/<VirtualDir>/<URL>
Example URL	https://localhost:8080/OTPA/V1/LoginToWebSocket
Description	This API request checks WebSocket connectivity. Once the logon request is successful, the system starts sending online order and trade messages.
Token Requirement	The request must include jToken received from the Authentication API response.

📝 WebSocket Logon Request Parameters

The WebSocket logon request includes the following elements:

Parameter	Data Type	Description
jMessageType	varchar(15)	Must be sent as "WEB_LOGON_REQ" indicating a WebSocket logon request
jAPIKey	varchar(255)	API key provided by SynapseWave Innovations Private Limited
jSecretKey	varchar(255)	Secret key provided by SynapseWave Innovations Private Limited
jToken	varchar(512)	Authentication token received from the Authentication API response
jRequestID	varchar(255)	Echo‑back field

Example WebSocket Logon Request

{
  "jMessageType": "WEB_LOGON_REQ",
  "jAPIKey": "<API Key>",
  "jSecretKey": "<Secret Key>",
  "jToken": "<Token received in Authentication Response>",
  "jRequestID": "<Echo back field>"
}

---

📝 WebSocket Login Response Parameters

The ResponseObject contains the following parameters.
This response is sent through the same WebSocket on which the login request was received.

Parameter	Data Type	Description
jMessageType	varchar(15)	Response message type — always "WEB_LOGON_RES"
jRequestID	varchar(255)	Echo‑back field (same as request)
jResponseID	varchar(255)	System‑generated alphanumeric ID
jStatuscode	int	1 = Success, -1 = Failure
jErrorString	varchar(255)	Free‑flowing error message (present only in failure cases)

Example Response

{
  "jMessageType": "WEB_LOGON_RES",
  "jRequestID": "<Echo back field>",
  "jResponseID": "<System generated alpha numeric id>",
  "jStatuscode": 1,
  "jErrorString": "<Free Flowing Error Message>"
}