Authentication

Over the past decade, REST APIs have become a de architectural approach for modern application platforms. However, as data moves across boundaries, security becomes a key concern for REST APIs containing sensitive information. One of the most straightforward ways to secure these APIs is to implement authentication mechanisms that control their exposure, mainly through user credentials and encrypted access codes.

NOTE : The conversationId is optional for loging API call . But after that it is mandatory to have conversationId with all subsequent requests.

API Log-In

/api/v1/auth/login 

Login-In Request

/api/v1/auth/login

1
2
3
4
5

{
    "userName": "user@verchaska.com",
    "password": "user@123",
    "companyCode": "CM000243"
}

Login-In Response

/api/v1/auth/login

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
   "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Login user",
        "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
    },
    "data": [
        {
            "sessionId": "5cbf6031-f4da-4360-89d6-009165a69041"
        }
    ],
    "version": "1.0.0"
}

API Log-Out

 /api/v1/auth/logout      

Log-Out Request

/api/v1/auth/logout

No request body required for logout request

Log-Out Response

/api/v1/auth/logout

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "",
        "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
    },
    "data": [
        "38b43c83-5dad-491d-9330-17956da93a96"
    ],
    "version": "1.0.0"
}

Authorization Error

If user do not provide an authorization header in request or user session is expired then user will receive an authentication error as given below:

{
    "meta": {
        "success": false,
        "statusCode": -2,
        "statusMessage": "UNAUTHORIZED",
        "actionType": "",
        "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
    },
    "errorDetails": {
        "code": "VAL-002",
        "type": "VALIDATION_ERROR",
        "title": "Authentication failed",
        "message": "Authentication failed. The sessionId is expired or Make sure you are using valid sessionId in header.",
        "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
        "path": "/api/v1/flight/search",
        "timestamp": 1684945506243
    }
}