Vendor Login


PURPOSE


This method allows the developer to login the client into the application. All the other APIs are dependent on successful running of this API. Once the Login is done, it creates a session during which the other APIs can be accessed and executed. It is a client authentication method to validate the client and extend the full arsenal of trading APIs and other historical data based on the valid credentials. There are 2 versions of login available which uses different parameters for login, which is dependent on the level of security and ease of access requirement of the particular client.

This version uses client’s Email-ID and contact number to login. This method requires less inputs from the client and can be extended by vendors for use to the clients by entering minimum credentials suitable for mobile logins.

Request Method: POST

Request format: JSON

Request Header:

Content-Type: application/json

Ocp-Apim-Subscription-Key:
to be provided after registration


REQUEST BODY


HEADER

Field Name Description Data Type
(max length)
Validation Sample Value
appName App Name provided at the time of registration String Cannot be empty. IIFLMarDEMO
appVer Developer App Version String Cannot be empty. 1.0
key UserKey generated at the time of registration String Cannot be empty. ABpyyGUh1nsbesSlup3VKURkI4tQDe8y
osName Channel of order String Cannot be empty. WEB, Android, iOS
request Code Request Code of the API called String Cannot be empty. IIFLMarRQLoginForVendor
userId User ID generated at the time of registration String Cannot be empty. ZkhghN5uKjPMU24Ae2etTA==
password Password generated at the time of registration String Cannot be empty. lfjnfS7rHGjEFzZ3xJHKww==

BODY

Field Name Description Data Type
(max length)
Validation Sample Value
Email_id Client’s Email id String (50) Cannot be empty. Demo123@gmail.com
LocalIP Local IP of the login requestor system String (20) - 123.123.12.12
PublicIP Public IP of the login requestor system String (20) - 123.123.12.12
Contact Number Vendor’s contact number String (15) Cannot be empty. 1234567890

REQUEST:

{
  "head": {
    "appName": "IIFLMarDEMO",
    "appVer": "1.0",
    "key": "ABpyyGUh1nsbesSlup3VKURkI4tQDe8y",
    "osName": "Android",
    "requestCode": "IIFLMarRQLoginForVendor",
    "userId": "ZkhghN5uKjPMU24Ae2etTA==",
    "password": "lfjnfS7rHGjEFzZ3xJHKww=="
  },
  "body": {
    "Email_id": "Demo123@gmail.com",
    "LocalIP": "123.123.123.123",
    "PublicIP": "123.123.123.12",
    "ContactNumber": "1234567890"
  }
}	

RESPONSE BODY


HEADER

Field Name Description Data Type
(max length)
List of Values Sample Value
responseCode This is the response code of API String - IIFLMarRQLoginForVendor
status This is the response code of API String 0
2
0
statusDescription This is the response code of API String 0 - Success
2 - Invalid head parameters
Success
responseCode This is the response code of API String - IIFLMarRQLoginForVendor

BODY

Field Name Description Data Type
(max length)
Sample Value
Message Message Type String "Invalid head parameters."
"Invalid Body Parameters."
“Success”
“Error while processing your request.”
Status 0 : Success
1/2: Invalid EmailID/ ContactNumber
3 : Invalid Password
4 : Validity Expired
5 : Incorect UserName
Int 0
TTManagerId client TTManagerId String -
UserName User Name of Vendor String IIFLDemoUser
ValidUpto Validity of Vendor to use APIs Service DateTime 8/20/2021 10:15:23 AM
VendorName Name of the Vendor String Demo
EmailId E-Mail ID of the vendor String Demo123@gmail.com

Success Response

{
  "head": {
    "responseCode": "IIFLMarRQLoginForVendor",
    "status": "0",
    "statusDescription": "Success"
  },
  "body": {
    "EmailId": "Demo123@gmail.com",
    "Message": "Successfully LoggedIn",
    "Status": 0,
    "TTManagerId": "",
    "UserName": "mocZueK622W",
    "ValidUpto": "8/20/2021 10:15:23 AM",
    "VendorName": "Demo"
  }
}