API Documentation

Overview

The HTTP API provides a simple way to integrate the functionality of our Faveo platform with your Application. You can leverage existing HTTP libraries available in almost all programming languages and try out or test the API easily using your favorite browser.

This document is explaining how to call a Faveo API and what will be response format.

Base Url : www.stablehelpdeskc.faveodemo.com

Getting Started

Note It is a good practice to URL encode all values when sending them via the HTTP API. This is especially required when Customer details, Contact details, Passwords, etc. contain special characters.

Additional Information HTML URL Encoding Reference

Note : When you try to access any API you should pass the Authentication token.The token you will get from te authentication API with your credentials.

Response Formats

Available Response Formats

The HTTP API currently supports the following response formats:

• XML
• JSON

Requesting a specific Response Format

You can specify the required Response Format as an extension to the URL path as illustrated below:

Example (JSON): /api/v1/json

Example (XML): /api/v1/xml

Note

• JSON response is returned by default, if no response format is specified.
• XML response API is still under construction. ONLY JSON AVAILABLE FOR NOW

For testing api_key: b8q3gMjJ484JTXsxRQyoZccYlruWM0lW

Authentication Details

Admin Username: demo_admin

Admin Password: demopass

Note : For security reasons, you should always send API requests using HTTPS. In a fresh installation of faveo, API feature is disabled by default. It can be enabled by going into the admin panel > setting > api and enabling API under API Configuration. API key is not mandatory by default but it can be made mandatory by going into the admin panel > setting > api and enabling “API key mandatory” under API Configuration. It generates an API key, which has to be passed with all the APIs for APIs to be accessible.

Common API's

• Access and authentication
• Register a User
• Get Authenticated User
• Check URL
• Create Ticket
• Reply to a ticket
• Edit a ticket
• Delete a ticket
• Open Tickets
• Unassigned Tickets
• Closed Tickets
• Get all agents
• Get all teams
• Search Customers
• Customers Specific information
• Fetch one customer by id
• Ticket Thread
• Get all help topic
• Get all sla plans
• Get all priorities
• Get all department
• Get all tickets
• Get inbox
• Create internal note
• Get trash tickets
• Get tickets by agents
• Get tickets by specific user
• Create collaborator
• Search for collaborator
• Collaborator fetch associated with ticket
• Collaborator remove
• Dependency API
• Get specific ticket details
• Faveo tickets API with filters and order
• Webhook integration
• Installer API