Available Response Formats The HTTP API currently supports the following response formats: XML JSON Basic Conventions for Response Json responses are divided into 3 fields: “success:” whenever a request results in a success, its value is going to be true else false “message:” this field will have the message(if any) “data”: this field will have […]
Category: External API
Common Errors
Token Errors: When authentication token is not provided { “success”: false, “message”: “Token not provided” } When authentication token provided is invalid { “success”: false, “message”: “Token invalid” } When authentication token expires { “success”: false, “message”: “Token expired” } Validation Errors: Validation Errors occurs when required field is […]
Knowledge base API’s
1. Search URL: api/search Method: get Response Format: JSON Description: Searches for articles in the knowledge base Parameters: Name Data Type Required / Optional Description s String Required The string that user wants to search token String Optional If the token is provided, backend considers that as logged in user, else guest Success Response: […]
Authenticate
Description: It will authenticate the user with the credentials and will generate a token. URL : api/v1/authenticate (Replace this URL with you helpdesk URL) Parameters : Name Data Type Required / Optional Description username String Required Username of the user/agent or Email of the user/Agent password String Required Password of […]
Register a User
Description: To register a user, call this API with required fields. URL : api/v1/helpdesk/register (Replace this URL with you helpdesk URL) Parameters : Name Data Type Required / Optional Description email String Required Email of the User or Agent api_key String optional An alphanumeric code that can be used […]
Get Authenticated User
Description: This API return the details of a authenticate user in Faveo. URL: api/v1/authenticate/user (Replace this URL with you helpdesk URL) Parameters : Name Data Type Required / Optional Description api_key String Optional An alphanumeric code that can be used to authenticate your API calls token String Required Token generated for a user HTTP Method: […]
URL
Description: This API is used to check the base URL(where Faveo is installed) is valid or not. URL : api/v1/helpdesk/url (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description url String Required Url of the website api_key String optional Api key HTTP […]
Create Ticket
Description: To create a ticket in Faveo. URL : api/v1/helpdesk/create (Replace this URL with you helpdesk URL) Parameters : Name Data Type Required / Optional Description api_key String Optional An alphanumeric code used to authenticate your API calls ip String Optional An IP address of the Customer/location where API […]
Reply Ticket
Description: To give reply for a particular ticket in Faveo. URL : api/v1/helpdesk/reply (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description api_key String Optional An alphanumeric code that can be used to authenticate your API calls ip String Optional An IP […]
Internal Note
Description: To post an internal note for a ticket in Faveo. URL : api/v1/helpdesk/internal-note (Replace this URL with you helpdesk URL) Parameters: Name Data Type Required / Optional Description api_key String Optional An alphanumeric code that can be used to authenticate your API calls ip String Optional IP […]