API Sequence Flow
📦🔀 Model 1 — Redirect
| API Name | Parameter / URL | Description | Reference |
|---|---|---|---|
| GetBrokerList | http://<domain>/vasprodmgmt/odinConnectorBrokerList | Displays broker at publisher end | BrokerList |
| Login & Execute Basket | • http://<domain>/landing/redirect with nRequestType=1 • http://<SERVERIP/DOMAIN>/landing/redirect?sAppToken=[Provided BySIPL]&sProductCode=P001&sTpUserId=XXXXX&sTwoWayToken=[Generated At PublisherEnd]&nRequestType=1&oEchoBackObject=[Return in CallBack Response]&sPartnerId=[Received inBrokerList Api Call] | • Display Broker Aero Page; • Need to implement TwoWayAuth and getBasketDetails URL at Publisher end | Vas Connector, Order Details, TwoWayAuth |
| Login Result | http://<PublisherDomain>?sStatusCode=<Code>&sStatusMessage=<Msg>&oEcoBackObject=<Obj> | Publisher will provide webhook URL | ThirdParty CallBack |
| Online Order/Trade Response | Written on Publisher Webhook | Publisher provides Webhook URL | OmexExtender |
| Order Sync | http://<domain>/omexorderandtraderesponse/sync | Sync data if not received on webhook | SyncOrderTrades |
📡 Model 2 — Smart Session
| API Name | Parameter / URL | Description | Reference |
|---|---|---|---|
| GetBrokerList | http://<domain>/vasprodmgmt/odinConnectorBrokerList | Displays broker at publisher end | BrokerList |
| Login | • http://<domain>/landing/redirect with nRequestType=2 • http://<SERVERIP/DOMAIN>/landing/redirect?sAppToken=[Provided By SIPL]&sProductCode=P001&sTpUserId=XXXXX&sTwoWayToken=[Generated At Publisher End]&nRequestType=2&oEchoBackObject=[Return in CallBack Response]&sPartnerId=[Received in BrokerList Api Call] | • Display Broker Aero Page • Need to implementTwoWayAuth and getBasketDetails URL at Publisher End | Vas Connector, TwoWayAuth |
| Login Result | http://< Publisher DOMAIN URL>/callback?sStatusCode=<Code>&sStatusMessage=<Message>&sTradingUserId=<TradingUserId>&sVasUserId=<sVasUserId>&sName=<UserName>&sEmail=<UserEmail>&sSession=<Token>&sRestSession=<Token> | Implement at publisher side | ThirdParty CallBack |
| Order Placement | http://<SERVERIP/DOMAIN>/landing/redirect?sAppToken=xx-xx- xx&sProductCode=p001&sTwoWayToken=XXX&nRequestType=3&sSession=ABC123 | • Pass session received in login response • Need to implement TwoWayAuth and getBasketDetails URL at Publisher End | Order Details, TwoWayAuth |
| Order Placement Result | http://< Publisher DOMAIN URL>/callback?sStatusCode=<Code>&sStatusMessage=<Message> | ||
| Online Order/Trade Response | Written on Publisher Webhook | Publisher provides Webhook URL | OmexExtender |
| Order Sync | http://<domain>/omexorderandtraderesponse/sync | Sync data if not received on webhook | SyncOrderTrades |
| Get Balance (Model 4 only) | http://<domain>/loginservice/apiKeys | Get ApiKey and Endpoint of REST API | GetAPIKeys |
🌐⚙️ Model 3 — Fully API-Based
| API Name | Parameter / URL | Description | Reference |
|---|---|---|---|
| GetBrokerList | http://<domain>/vasprodmgmt/odinConnectorBrokerList | • Displays Broker at Publisher End • Need to implement TwoWayAuth URL at Publisher End | BrokerList |
| Get Endpoint and ApiKey | http://<domain>/loginservice/apiKeys | • To get ApiKey and Endpoint of Rest Api • Use Interactive Session Only | GetAPIKeys |
| Login, Order Placement, Order Book, Trade Book, Net Position and others | Refer ODIN REST API | Different from ODIN Connector document | ODIN APIs |
🧩⚡Model 4 — Hybrid
| API Name | Parameter / URL | Description | Reference |
|---|---|---|---|
| GetBrokerList | http://<domain>/vasprodmgmt/odinConnectorBrokerList | Displays broker at publisher end | BrokerList |
| Login | • http://<domain>/landing/redirect • http://<SERVER IP/DOMAIN>/landing/redirect?sAppToken=[Provided By SIPL]&sProductCode=P001&sTpUserId=XXXXX&sTwoWayToken=[Generated At Publisher End]&nRequestType=2&oEchoBackObject=[Return in CallBack Response]&sPartnerId=[Received in BrokerList Api Call] | • Displays Broker Aero Page End • Need to implement TwoWayAuth and getBasketDetails URL at Publisher End | Vas Connector, TwoWayAuth |
| Login Result (Success/Failure) | http://<PublisherDomain>/callback?...&sSession=<Token>&sRestSession=<Token> | Implement at publisher side | ThirdParty CallBack |
| Get Endpoint and ApiKey | http://<domain>/loginservice/apiKeys | • To get ApiKey and Endpoint of Rest Api • Use interactive session only | GetAPIKeys |
| Order Placement, Order Book, etc. | Refer ODIN REST API — use sRestSession from login response | Different from ODIN Connector document | ODIN APIs |
| Online Order/Trade Response | Written on Publisher Webhook | Publisher provides Webhook URL | OmexExtender |
| Order Sync | http://<domain>/omexorderandtraderesponse/sync | Sync data if not received on webhook | SyncOrderTrades |