Blogue

Les Filtres d’API

Filtrer avec l'API

Il est possible d’ajouter des filtres à la fin des requêtes API pour préciser les résultats, ou pour rechercher un objet ou liste d’objet précis dans la base de donnée.

Exemple:

xxx.phpcreation.com/platform/v3/products?access_token=123&price=10

Recherche

Pour rechercher par terme semblable, on doit spécifier un filtre de recherche.

Modèle:

?champs=valeur

Exemple:

xxx.phpreaction.com/platform/v3/brands?access_token=123&price=10&name=shirt

 

 
 
on peut ajouter plusieurs valeurs possible sur un filtre “exact” de la façon suivante:
xxx.phpreaction.com/platform/v3/brands?access_token=123&supplier[]=1&supplier[]=2&supplier[]=3
 
 
* Ne pas oublier les braguettes d’array ([]) sinon seulement le dernier filtre sera appliqué.
 

Date

Permet de rechercher par dates, en utilisant un range de dates.

Syntaxe:

La valeur dans la requête permet de déterminer si on veut les dates avant ou après la date entré, Inclusivement ou Exclusivement.

  • before => Inclut la date entrée, ainsi que toutes les dates antérieures.
  • after => Inclut la date entrée, ainsi que toutes les dates ultérieures.
  • strictly_before => Seulement les dates antérieures à la date entrée.
  • strictly_after => Seulement les dates ultérieures à la date entrée.

Modèle:

?champs[<after|before|strictly_after|strictly_before>]=value

Exemple:

xxx.phpreaction.com/platform/v3/brands?access_token=123&createdAt[after]=2018-03-19

Étendu Numérique

Permet de rechercher par nombre, en utilisant un range de nombres (Prix par exemple)

 

Syntaxe:

La valeur dans la requête permet de filtrer tous les champs situés entre deux nombres inclusivement.

  • Il est possible d’utiliser des décimales, avec le point “.”
  • Séparer les deux nombres par un double point “..” pour ne pas confondre avec les décimales.

Modèle:

?champs[between]=X..Y

Exemple:

xxx.phpreaction.com/platform/v3/offers?access_token=123&price[between]=12.99..15.99

Ordonner

On peut changer l’ordre dynamiquement par le biais de filtres spéciaux selon la syntaxe qui suit :

Modèle:

?order[champs]=ASC|DESC

Utiliser ASC pour un tri croissant et DESC pour un tri décroissant

Exemple:

xxx.phpreaction.com/platform/v3/products?access_token=123?order[id]=ASC