2 * API Add - lew13010/OCR-Api GitHub Wiki

Query list "POST" to add

Add category

yourdomain.com/api/add/category?name=Categorie 1

  • API verifies the duplicate. (No duplicate possible)

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
 'message'   => 'Categorie ajoutée avec succès',
 'id'        =>  1
}

Return Failure:

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   =>  "La categorie 'Categorie 1' existe déjà dans la BDD avec l'id : 1"
}

Add city

yourdomain.com/api/add/city?name=Paris

  • API verifies if the city exist in France. (Only French cities are accepted)
  • API verifies the duplicate. (No duplicate possible)

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
 'message'   => 'Ville ajoutée avec succès',
 'id'        =>  1
}

Return Failure:

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   =>  "La ville 'Rio de janeiro' n'existe pas en France"
}

Add advert

yourdomain.com/api/add/advert?{parameters}

Parameters

Mandatory :

  • title
  • category (slugCat) API verifies if the category exist in Database.
  • city (name) API verifies if the city exist in Database.
  • description

Optional :

  • price (integer)
  • images (only format : png/jpg/jpeg)

Exemple

yourdomain.com/api/add/advert?title=Title&category=Categorie-1&city=Paris&description=My description...&price=10

Return Success :

{
 'success'   =>  true,
 'code'      =>  200,
 'message'   => 'Annonce ajoutée avec succès',
 'id'        =>  1
}

Return Failure:

{
 'success'   =>  false,
 'code'      =>  412,
 'message'   =>  'Veuillez saisir le parametre "title"'
}