This v1 API  will be deprecated from 15th March 2020

Description:

This API is used to install Faveo Helpdesk desktop edition

Category:-

This API has two categories

 

  • To config database

 

          URL : api/v1/database-config

 

  • To complete installation

          URL : api/v1/system-config

Parameters :

Name Data Type Required/Optional Description
default String Required Faveo makes a connection with databases and running queries extremely simple across a variety of database.

Currently, Faveo supports three database systems

  1. mysql
  2. pgsql
  3. sqlsrv
host String Required Here goes the database server IP address
databasename String Required Name of database
dbusername String Required Database user
dbpassword String Optional Database user’s password
port Integer Optional Port has to be filled if required. In some cases port are required to connect to the database server.

Eg:- 8888

firstname String Required First name of Admin
lastname String Required Late name of Admin
email String Required Email of the admin
username String Required Username of the admin / could be admin
password String Required Password (min:6 / max:20)
timezone String Required Below are the mentioned the list of time-zones supported by Faveo

Pacific/Midway

US/Samoa

US/Hawaii

US/Alaska

US/Pacific

America/Tijuana

US/Arizona

US/Mountain

America/Chihuahua

America/Mazatlan

America/Mexico_City

America/Monterrey

Canada/Saskatchewan

US/Central

US/Eastern

US/East-Indiana

America/Bogota

America/Lima

America/Caracas

Canada/Atlantic

America/La_Paz

America/Santiago

Canada/Newfoundland

America/Buenos_Aires

Greenland

Atlantic/Stanley

Atlantic/Azores

Atlantic/Cape_Verde

Africa/Casablanca

Europe/Dublin

Europe/Lisbon

Europe/London

Africa/Monrovia

Europe/Amsterdam

Europe/Belgrade

Europe/Berlin

Europe/Bratislava

Europe/Brussels

Europe/Budapest

Europe/Copenhagen

Europe/Ljubljana

Europe/Madrid

Europe/Paris

Europe/Prague

Europe/Rome

Europe/Sarajevo

Europe/Skopje

Europe/Stockholm

Europe/Vienna

Europe/Warsaw

Europe/Zagreb

Europe/Athens

Europe/Bucharest

Africa/Cairo

Africa/Harare

Europe/Helsinki

Europe/Istanbul

Asia/Jerusalem

Europe/Kiev

Europe/Minsk

Europe/Riga

Europe/Sofia

Europe/Tallinn

Europe/Vilnius

Asia/Baghdad

Asia/Kuwait

Africa/Nairobi

Asia/Riyadh

Asia/Tehran

Europe/Moscow

Asia/Baku

Europe/Volgograd

Asia/Muscat

Asia/Tbilisi

Asia/Yerevan

Asia/Kabul

Asia/Karachi

Asia/Tashkent

Asia/Kolkata

Asia/Kathmandu

Asia/Yekaterinburg

Asia/Almaty

Asia/Dhaka

Asia/Novosibirsk

Asia/Bangkok

Asia/Ho_Chi_Minh

Asia/Jakarta

Asia/Krasnoyarsk

Asia/Chongqing

Asia/Hong_Kong

Asia/Kuala_Lumpur

Australia/Perth

Asia/Singapore

Asia/Taipei

Asia/Ulaanbaatar

Asia/Urumqi

Asia/Irkutsk

Asia/Seoul

Asia/Tokyo

Australia/Adelaide

Australia/Darwin

Asia/Yakutsk

Australia/Brisbane

Australia/Canberra

Pacific/Guam

Australia/Hobart

Australia/Melbourne

Pacific/Port_Moresby

Australia/Sydney

Asia/Vladivostok

Asia/Magadan

Pacific/Auckland

Pacific/Fiji

datetime String Required Below are mentioned the required format for date formats

  1. d/m/Y H:i:s
  2. d.m.Y H:i:s
  3. d-m-Y H:i:s
  4. m/d/Y H:i:s
  5. m.d.Y H:i:s
  6. m-d-Y H:i:s
  7. Y/m/d H:i:s
  8. Y.m.d H:i:s
  9. Y-m-d H:i:s

 

HTTP Method : GET         

  •   URL Request Example:
  1. Url to config database

http://www.website.com/support/api/v1/database-config?database=mysql&host=localhost&databasename=dbname&dbusername=root&dbpassword=anything&port=8888

  1. If you have the public in your URL then try this mentioned below

http://www.website.com/support/public/api/v1/database-config?database=mysql&host=localhost&databasename=dbname&dbusername=root&dbpassword=anything&port=8888

  1.    Parameters: database
    1. host
    2. databasename
    3. dbusername
    4. dbpassword
    5. port
  1. Url to migrate the database and create admin credentials

http://www.website.com/support/api/v1/system-config?firstname=admin&lastname=admin&email=admin%40faveo.com&username=admin%40faveo.com&password=demopass&timezone=Asia%2FKolkata&datetime=d%2Fm%2FY+H%3Ai

  1.  If you havthe e public in your URL then try this mentioned below

http://www.website.com/support/public/api/v1/system-config?firstname=admin&lastname=admin&email=admin%40faveo.com&username=admin%40faveo.com&password=demopass&timezone=Asia%2FKolkata&datetime=d%2Fm%2FY+H%3Ai

  1. Parameters:
    1. firstname
    2. lastname
    3. email
    4. username
    5. password
    6. timezone
    7. datetime

Explanation of the URL’s

Here we have two urls:-

  1. In the first, url one can configure the config database file.
  2. In the second, url one needs to migrate the database and register the user details to the database.

Response

  •   Response Format : JSON
  •   Returns JSON which contains below response

Success Response:

   {

         ‘response’=>’success’,

         ‘status’=>’1’

  }

Failure Response:

  1. For re-installation

         {

             ‘response’=>fail,

             ‘reason’=>’this system is already installed’,

             ‘status’=>’0’

         }

  1. For insufficient/error in parameters

          {

             ‘response’=>fail,

             ‘reason’=>’insufficient parameters’,

             ‘status’=>’0

         }

         {

             ‘response’=>fail,

             ‘reason’=>’invalid time-zone’,

             ‘status’=>’0’

         }

 

         {

             ‘response’=>fail,

             ‘reason’=>’invalid date-time format’,

             ‘status’=>’0

         }

 

Leave a Reply

Your email address will not be published.