Overview

Login is an authentication process that a user has to go through at the initial stage. A user can access the platform only if authorized through this process.

To perform a login request, a user must have the following information:

Required header info:

Client ID
Client code
Signature

Required body info:

Username
Password

The request is posted to the login URL https://servicesuat.onesingleview.com/v1/api/osvPlatform/login in the specified format with all the required details. The system then processes the information to authenticate, and a response is generated based on the validity of the details.

Get Access Token & SID

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`/v1/api/osvPlatform/login`	POST	1. `clientId` 2. `clientCode` 3. `signature`

Sample login request

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/osvPlatform/login' \
--header 'clientId: Enter_Client_ID' \
--header 'clientCode: Enter_Client_Code' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
"osvPlatformLoginRQ" :{
  "userName":"Enter_Username",
  "password":"Enter_Password"
}
}'

Login request description:

JSON Tag	Description	Data type
clientId Mandatory	Client ID	String
clientCode Mandatory	Client Code	String
signature Mandatory	Signature	String
osvPlatformLoginRQ Mandatory	Login Request Tag	Object
userName Mandatory	Account Username	String
password Mandatory	Account Password	String

Sample login responses

Valid response

✔️ If a Valid login request goes through the successful authentication process

{
  "osvPlatformLoginRS": {
    "statusCode": "200",
    "status": "SUCCESS",
    "message": "Welcome Message",
    "accessToken": "Access_Token",
    "sid": "Session_ID"
  }
}

Valid response description:

JSON Tag	Description	Data type
osvPlatformLoginRS	Login Response Tag	Object
statusCode	Status Code of the response	String
status	Status Details of the response	String
message	Response Message	String
accessToken	Access Token	String
sid	Session ID	String

Invalid response

❌ If an Invalid login request goes through the authentication process

{
  status: "FAILURE",
  errorCode: "Error_Code",
  message: "Invalid_Message"
}

Invalid response description:

JSON Tag	Description	Data type
status	Status of the response	String
errorCode	Error Code	String
message	Response Message	String

Response in case a technical error is encountered

⚠️ If the authentication process encounters a technical error; irrespective of the validity of the request details

{
  status: "TECHERROR",
  errorCode: "Error_Code",
  message: "Error_Message"
}

Error response description:

JSON Tag	Description	Data type
status	Status of the response	String
errorCode	Error Code	String
message	Response Message	String