Overview

Login is an authentication process a user must 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.

Try login

Sample 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_user_name",
  "password":"Enter_password"
}
}'

Login request description:

Sample 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:

Invalid response

❌ If an Invalid login request goes through the authentication process

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

Invalid response description:

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: