Chapitre 8 – Utilisation avancée

Option de rendu

Inclure tous les champs de la ressource produit "products"

URL: (URL de la boutique)/api/products/?display=full

PHP:

$opt = array( 'resource' => 'products', 
              'display'  => 'full' );

N'inclure que l'ID de tous les transporteurs "carriers"

URL: (URL de la boutique)/api/products/

PHP :

$opt = array( 'resource' => 'products' );

N'inclure que les champs "name" et "value" de la ressource "configurations"

URL: (URL de la boutique)/api/configurations/?display=[name,value]

PHP:

$opt = array( 'resource' => 'configurations', 
              'display'  => '[name,value]');

Filtres de rendu

N'inclure que les noms et prénoms des clients "customers" ayant l'id 1 et 5

URL: (URL de la boutique)/api/customers/?display=[firstname,lastname]&filter[id]=[1|5]

PHP:

$opt = array( 'resource'   => 'customers', 
              'display'    => '[firstname,lastname]', 
              'filter[id]' => '[1|5]' );

N'inclure que les noms des clients "customers" ayant un id compris entre 1 et 10

URL: (URL de la boutique)/api/customers/?display=[lastname]&filter[id]=[1,10]

PHP:

$opt = array( 'resource'   => 'customers', 
              'display'    => '[lastname]', 
              'filter[id]' => '[1,10]');

N'inclure que la date de naissance du client ayant pour nom "John" et prénom "DOE"

URL: (URL de la boutique)/api/customers/?display=[birthday]&filter[firstname]=[John]&filter[lastname]=[DOE]

PHP:

$opt = array( 'resource'          => 'customers', 
              'display'           => '[birthday]', 
              'filter[firstname]' => '[John]', 
              'filter[lastname]'  => '[DOE]' );

N'inclure que les noms des constructeurs "manufacturers" dont le nom commence par "Appl"

URL: (URL de la boutique)/api/manufacturers/?display=[name]&filter[name]=[appl]%

PHP:

$opt = array( 'resource'     => 'manufacturers', 
              'display'      => '[name]', 
              'filter[name]' => '[appl]%');

Filtres de tri

Trier les clients "customers" en ordre alphabétique du nom

URL: Store URL/api/customers?display=full&sort=[lastname_ASC]

PHP:

$opt = array( 'resource' => 'customers', 
              'display'  => 'full', 
              'sort'     => '[lastname_ASC]' );

Filtres de limitation de rendu

N'inclure que les 5 premiers états «"states"

URL: (URL de la boutique)/api/states/?display=full&limit=5

PHP:

$opt = array( 'resource' => 'states', 
              'display'  => 'full', 
              'limit'    => '5' );

N'inclure que les 5 éléments à partir du 10ème élément de la ressource état "states"

URL: (URL de la boutique)/api/states/?display=full&limit=9,5

PHP:

$opt = array( 'resource' => 'states', 
              'display'  => 'full', 
              'limit'    => '9,5' );