Login
Connect to the broker, only once this function has returned successfully can any other operations be performed.
Request to be POSTed to uri : /NorenWClientTP/QuickAuth
Request Details :
| Parameter Name | Possible value | Description |
|---|---|---|
| jData* | Should send json object with fields in below list |
| Json Fields | Possible value | Description |
|---|---|---|
| apkversion* | Application version. | |
| uid* | User Id of the login user | |
| pwd* | Sha256 of the user entered password. | |
| factor2* | DOB or PAN as entered by the user. (DOB should be in DD-MM-YYYY) | |
| vc* | Vendor code provided by ProStocks | |
| appkey* | Sha256 of uid | Api key | |
| imei* | Send mac if users logs in for desktop, imei is from mobile | |
| addldivinf | Optional field, Value must be in below format:iOS - iosInfo.utsname.machine - iosInfo.systemVersion ,Android - androidInfo.model - androidInfo.version.For examples:iOS - iPhone 8.0 - 9.0,Android - Moto G - 9 PKQ1.181203.01, WEB - Chrome-125.0.0.0 | |
| ipaddr | Optional field | |
| source | API |
Example
curl --location 'apitest.co.in:9959/NorenWClient/QuickAuth' \
--header 'Content-Type: text/plain' \
--data 'jData={"apkversion":"1.0.9", "uid":"TEST_USER", "pwd":"8776f108e247ab1e2b39c266407c81fbad41bde1e8dfc1bb66fd267e","factor2":"521365","imei":"134243434","source":"API", "vc":"TEST_USER","appkey":"1f4a90f5d57d4204b0106bd2b4570ded6a1d80bc4b1c87046f7f"}'
Response Details :
| Json Fields | Possible value | Description |
|---|---|---|
| stat | Ok or Not_Ok | Login Success Or failure status |
| susertoken | It will be present only on login success. This data to be sent in subsequent requests in jKey field and web socket connection while connecting. | |
| lastaccesstime | It will be present only on login success. | |
| spasswordreset | Y [If emsg is “Password Expired” or “Change Password” and stat is Not_Ok ] | If Y Mandatory password reset to be enforced. Otherwise the field will be absent. |
| exarr | Json array of strings with enabled exchange names | |
| uname | User name | |
| prarr | Json array of Product Obj with enabled products, as defined below. | |
| actid | Account id | |
| Email Id | ||
| brkname | Broker id | |
| uid | UserId | |
| brnchid | Region | |
| emsg | This will be present only if Login fails. | |
| dmsg | Display message, (will be present only in case of success). |
Sample Success Response :
{
"request_time": "20:18:47 19-05-2020",
"stat": "Ok",
"susertoken": "3b97f4c67762259a9ded6dbd7bfafe2787e662b3870422ddd343a59895f423a0",
"lastaccesstime": "1589899727"
}
Sample Failure Response :
{
"request_time": "20:32:14 19-05-2020",
"stat": "Not_Ok",
"emsg": "Invalid Input : Wrong Password"
}
Error Message list:
| Message | Description |
|---|---|
| "Invalid Input : Missing jData" | Common error message of any of the API (dev issue) |
| “Invalid Input : Request data is missing.” | Common error message of any of the API (dev issue) |
| "Invalid Input : jData is not valid json object" | Common error message of any of the API (dev issue) |
| "Invalid Input : {<Mandatory field name 1>} {or <Mandatory field name n>}... is Missing." Example: | Common error message of any of the API (dev issue) |
| "Invalid Input : One or more input parameters are not in string format" | Common error message of any of the API (dev issue) |
| "Invalid Input : Invalid App Key" | API enablement configuration issue (dev/deploy issue) |
| "Invalid Input : Invalid Vendor code" | API enablement configuration issue (dev/deploy issue) |
| “Invalid Input : Latest app available, please update” | Version blocked at API server level |
| "Invalid Input : Wrong PAN/DOB" | |
| "Invalid Input : Wrong Password" | |
| "Invalid Input : Invalid User" | |
| "Invalid Input : Deactivated" | |
| "Invalid Input : Version blocked: Please download latest version" | Version blocked in OMS level |
| "Invalid Input : User Blocked due to multiple wrong attempts" | |
| "Invalid Input : User Not enabled on : WEB" Or "Invalid Input : User Not enabled on : ---" | Depending on custom access type configured in the system message will change |
| "Error Occurred : 1 "unknown request"" Or “Server Timeout : ” | OMS is down and Web server only up, (EOD/BOD time) |
| "Invalid Input : Invalid Access Type" | API server instance is not configured to handle input access type. (Mismatch in API URL) |
| "Invalid Input : Password Expired" | Password expired after configured number of days, Redirect to Change password screen. |
| "Invalid Input : Change Password" | If password reset by admin/system, Redirect to Change password screen. |