Access and Authentication

Description : Authenticates a Faveo user by returning an authentication token on successful authentication. Locating your API Key Login to your Faveo Admin Panel. Click API. Your unique API Key will be displayed. You may generate a fresh API Key by clicking the Generate link.

1. URL : api/v1/authenticate

Parameters :

Name	Data Type	Required/Optional	Description
username	String	Required	Usename of the user
password	String	Required	Password of the user
api_key	String	Optional	An alphanumeric code that can be used to authenticate your API calls. To make it required login to Admin panel and go to API setting and make it mandatory

HTTP Method : POST

Response Format : JSON

Response : Returns json response with the token.This token will be used in all other API’s as authentication purpose. In case of any errors, an error message will be returned.

URL Request Example : https://www.stablehelpdeskc.faveodemo.com/api/v1/authenticate?username=demoadmin&password=demopass

JSON Response Example :

Success Response :

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9wcm9kdWN0ZGVtb3VybC5jb21cL2NvbW11bml0eVwvcHVibGljXC9hcGlcL3YxXC9hdXRoZW50aWNhdGUiLCJpYXQiOjE1MzUwMDcwMjIsImV4cCI6MTUzNTAwNzI2MiwibmJmIjoxNTM1MDA3MDIyLCJqdGkiOiJsU3E5N1JvVUtiRDBjelpsIiwic3ViIjoxLCJwcnYiOiI4N2UwYWYxZWY5ZmQxNTgxMmZkZWM5NzE1M2ExNGUwYjA0NzU0NmFhIn0.DUGRce3eS4EcKAaP-toTyzrkjq3zVxwdlDjfv5U2T9c",
    "user_id": {
        "id": 1,
        "user_name": "demoadmin",
        "first_name": "Demo",
        "last_name": "Admin",
        "gender": 0,
        "email": "[email protected]",
        "ban": 0,
        "active": 1,
        "is_delete": 0,
        "ext": "",
        "country_code": 0,
        "phone_number": "",
        "mobile": null,
        "agent_sign": "",
        "account_type": "",
        "account_status": "",
        "assign_group": 1,
        "primary_dpt": 1,
        "agent_tzone": "",
        "daylight_save": "",
        "limit_access": "",
        "directory_listing": "",
        "vacation_mode": "",
        "company": "",
        "role": "admin",
        "internal_note": "",
        "profile_pic": "https://secure.gravatar.com/avatar/b4bfa60e2b38b40cf980d30da5f6373b?s=80&r=g&d=identicon",
        "created_at": "2018-08-13 14:22:49",
        "updated_at": "2018-08-13 14:23:14",
        "user_language": null
    }
}

Some Common Error :

Error Response :

{
"Error":"invalid_credentials"
"status_code": 401
}

Response Description :

Parameter	Description
id	id of the user
user_name	user name of the user
first_name	first name of the user
last_name	last name of the user
gender	gender of the user
email	email of the user
ban	indicates if the user is banned or not
active	indicates if the user is active or not
is_delete	indicates if the user is deleted or not
ext	indicates extension of the phone number
country_code	indicates the country code of the user
phone_number	phone number of the user
mobile	mobile number of the user
agent_sign	id of the user
account_type	indicates the type of the user account
account_status	indicates the status of the user account
assign_group	indicates the group in which the user is assigned to
primary_dpt	indicates the primary department of the user
agent_tzone	indicates the time zone of the user
daylight_save	id of the user
limit_access	id of the user
directory_listing	id of the user
vacation_mode	id of the user
company	indicates the company of the user
role	indicates the role of the user
internal_note	id of the user
created_at	indicates when the user profile is created
profile_pic	id of the user
updated_at	indicates when the user profile is last updated
user_language	indicates the user language