diff --git a/README.md b/README.md index 524690d..74921c8 100644 --- a/README.md +++ b/README.md @@ -1,134 +1,52 @@ [![GitHub stars](https://img.shields.io/github/stars/shakee93/fonoapi.svg)](https://github.com/shakee93/fonoapi/stargazers) -[![GitHub issues](https://img.shields.io/github/issues/shakee93/fonoapi.svg)](https://github.com/shakee93/fonoapi/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/shakee93/fonoapi/master/LICENSE) -# API IS DOWN DUE TO HEAVY LOAD ON THE SERVER -## sorry for the inconvienience, it will be back up soon ! -## Thanks. - -# FonoApi - Mobile Device Description Api - -* Database Updated : 21st September 2016 -* Database Updated (New Devices Added) : 27th November 2016 -* Database Updated (Old Device Data Updated) : 27th November 2016 -* Database Updated (New Devices Added) : 4th January 2017 -* Database Updated (Old Device Data Updated) : 4th January 2017 -* Database Updated (New Devices Added) : 6th February 2017 -* Database Updated (Old Device Data Updated) : 6th February 2017 -* Database Updated (New Devices Added) : 3rd March 2017 -* Database Updated (Old Device Data Updated) : 3rd March 2017 -* Database Updated (New Devices Added) : 5th April 2017 -* Database Updated (Old Device Data Updated) : 5th April 2017 -* Database Updated : 8th May 2017 -* Database Updated : 10th July 2017 -* Database Updated : 10th August 2017 -* Database Updated : 15th September 2017 -* Database Updated : 15th October 2017 -* Database Updated : 17th November 2017 -* Database Updated : 12th December 2017 -* Database Updated : 22th January 2018 -* Database Updated : 23th February 2018 -* Database Updated : 30th April 2018 -* Database Updated : 28th August 2018 -* Database Updated : 29th MARCH 2019 +# Getting Started With TechSpecs API -https://fonoapi.freshpixl.com/ +TechSpecs API provides the easiest way to get instant access to the official technical specifications of the worlds' consumer electronics. Our database is the largest and most up-to-date in the world so you can be sure you're always getting the latest information. +**Available categories;** +* Smartphones +* Tablets +* Smartwatches -This is an API which can provide mobile device descriptions such as model, brand, CPU, GPU, dimensions, release date etc. It might be helpful if you are building a website like GSMAera, Phonearena or something similar. This API contains a database of a mobile device descriptions of Android, iOS and some old phones too.. :D -This is the PHP class to communicate with the API. It would be nice if someone can help with other languages though. ;) +**Available Endpoints;** +* POST: Search for a product +* GET: Detailed specifications of a product +* GET: All Categories +* GET: All Brands -### Api +**Available Datapoints;** +* Specifications: **Dimension, Weight, Display, Camera, Battery, CPU, GPU, and over 200 more…** +* Images: **Front view, Back view** +* Prices: Available Soon -API URL: https://fonoapi.freshpixl.com/v1/ +## Try It +Visit https://techspecs.readme.io to try the endpoints. -###### Method `getdevice` (https://fonoapi.freshpixl.com/v1/getdevice) +![alt text](https://i.imgur.com/VJLZSE3.png) -Available options - - brand - - Pass the Mobile Device Brand (example : "samsung", "htc") - - device* - - Pass nearly relevent mobile device name (example : "i9305", "A8") - This might result multiple results at a time. - - position - - When a set of results is returned you can get a specific device by passing the position of your device on the result set. count starts from 0 - - token* - - You will need a token to access the Api. no registration, nothing, just grab the key. - You can get it here https://fonoapi.freshpixl.com/token/generate -###### Method `getlatest` (https://fonoapi.freshpixl.com/v1/getlatest) -Available options - - brand - - It gives the latest you can filter the brand (example : "samsung", "htc") - - limit - - Limit the result count (Max 100) - - token* - - You will need a token to access the Api. no registration, nothing, just grab the key.
- You can get it here https://fonoapi.freshpixl.com/token/generate +## Get API Key +Visit https://developer.dashboard.techspecs.io/signup to signup and get your API key. Registration is free, no credit card required. -Note: the API will return only 100 devices per request ------- -###### PHP Demo +## Read the Docs +Visit https://techspecs.readme.io to read the documentation. -Install the package in your PHP project: -```bash -$ composer require shakee93/fonoapi -``` +## Search Engine Demo +Visit https://techspecs.io to try the frontend search engine -``` -DeviceName)) echo "Device : ". $mobile->DeviceName . "
"; - if (!empty($mobile->Brand)) echo "Brand : ". $mobile->Brand . "
"; - if (!empty($mobile->cpu)) echo "Cpu : " . $mobile->cpu . "
"; - if (!empty($mobile->status)) echo "Status : " . $mobile->status . "
"; - if (!empty($mobile->dimensions)) echo "Dimensions : " . $mobile->dimensions . "
"; - if (!empty($mobile->_4g_bands)) echo "4g : " .$mobile->_4g_bands . "
"; - } -} catch (Exception $e) { - echo "ERROR : " . $e->getMessage(); -} -``` ------- - -###### Curl Example - -```bash -curl https://fonoapi.freshpixl.com/v1/getdevice -XPOST -H 'Accept: application/json' -d 'token=YOUR_TOKEN_HERE&limit=5&device=A8' -``` - -###### Python - -Library is here : https://github.com/jesusperiago/fonoapi - -###### jQuery - -Library is here : https://github.com/shakee93/fonoapi/tree/master/fonoapi-js - -###### Nodejs - -Library is here : https://github.com/mtrung/fonoapi/tree/master/fonoapi-nodejs -Package is here : https://www.npmjs.com/package/fonoapi-nodejs - -###### Java - Library is here : https://github.com/aafanasev/fonoapi-client - ------- - -##### Result Set Structure - -Check here : https://github.com/shakee93/fonoapi/blob/master/resultset.md