Login

SIGN IN

Endpoint: /api/signin

This is the endpoint for signing in and get API token from envois.io server.

• Method: POST
• Content-Type: application/json

Request Body:

    {
        "username":"<your-user-name>", //string 
        "password":"<your-password>"   //string 
    }

Response Body: (Status: 200)

    {
    "token": "<your-token>",
    "expiresAt": "<expire date-time>",
    "userid": "<your-user-id>",
    "UserType": "<your-user-type>",
    "additional_info": {
        "UserName": "<your-user-name>"
    },
    "UserName": "<your-user-name>",
    "Email": "<your-email-address>",
    "FullName": "<your-full-name>"
    }

Response Body: (Status: 401 - Unauthorized)

When username and or password is wrong you will get the below error message:

{
    "message": "Authentication Failed!"
}

Response Body: (Status: 401 - Unauthorized)

When the username is an empty field you will get the below error message:

{
    "message": "Invalid Credentials",
    "rStatus": false
}

Response Body: (Status: 401 - Unauthorized)

When user is locked:

{
    "message": "User is locked Contact your administrator!"
}