API Documentation

Login

The Authentication API generates a secure token for users when logging into the system. This token must be included in subsequent API calls to access QEval services.

URL  https://{Subdomain}.qevalpro.com/api/Authenticate/Login
Method  Post
Sub Domains “app” or “ai”

1. Sample Request (Payload)

</> JSON 
[
    {
        "UserName": "Enter Username",
        "Password": "Enter Password"
    }
]

2. Description for Request Parameters

S.No Name Type Description Is Required?
1 Username String Username used to log in to the application. Yes
2 Password String Password associated with the user account for authentication. Yes

3. Response Examples

Success:

</> JSON 
[
    {
        "Message": "Success",
        "Token": "####",
        "UserID": 1234,
        "UserName": "Patrick",
        "UserFirstName": "Patrick",
        "UserLastName": "James",
        "RoleId": 8,
        "ClientID": 12,
        "EmpId": 22445,
        "X_API_KEY": "####"
    }
]

Status Code

Code Status Description
200 Success Token generated

Failure:

</> JSON 
[
    {
        "Message": "The request is invalid"
    }
]

Status Code

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

Note:

All API requests (except the Login API) require two-factor authentication using the following request headers:

  • Authorization: Bearer <Generated_Token>
    • The Bearer Token is generated upon successful login.
  • X-API-KEY: <Your_Unique_API_Key>
    • This API key is assigned by the QEval team and must be included in all subsequent API requests.

If the X-API-KEY is not available in your environment or has not been provided, please contact the QEval team at Qeval@etechtexas.com to obtain the required key.

    ×

    Contact Us