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 the data part of the response (if any).

Sample JSON Code Format:

{ 
    "success":  //can be true or false
    "message": //success or error message
    "data":    //data
}

NOTE: 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.

Leave a Reply

Your email address will not be published.