Le document présente une introduction à l'utilisation de l'API REST de WooCommerce, décrivant ses principes fondamentaux, les types de requêtes HTTP et les méthodes d'interaction avec les données. Il aborde également la gestion des erreurs, la création et la mise à jour de produits via l'API, ainsi que des conseils pour tester le client REST dans un environnement local avec des outils comme Vagrant et WP-CLI. Enfin, des exemples de code et des recommandations pour rédiger des tests unitaires sont fournis pour améliorer l'efficacité des développements.

1. Comprendre et utiliser
l’API REST de
WooCommerce
Maxime VARINARD - Vaisonet
WordCamp Lille 2018

2. C’est quoi un
webservice ?

3. Un webservice
Technique
Basé sur HTTP
Source : www.commentcamarche.com

4. Un webservice
Technique
Basé sur HTTP
Ce n’est pas de l’échange de fichier et
ça change tout !

5. Un webservice
Technique
Basé sur HTTP
Avantages
● Validation des
données
● Gestion des erreurs
● Pare-feu
● Interopérable
● Standard et
compréhensible
Inconvénients

6. Comment ça
fonctionne ?

7. Initialisation
Je fais une requête
HTTP
Modification
J’interprète la réponse
et je la modifie
Envoi
Je renvoie les
données
Interprétation
Le serveur analyse les
données et renvoie
une réponse
Gestion
Je réagis à la réponse
(OK / KO)

8. Un peu de jargon

9. Un peu de jargon
● XML-RPC
● SOAP
● REST
● XML
● JSON
● GraphQL

10. HTTP et
validation des
données

11. Type de requête HTTP
● GET pour lire
● POST pour créer
● PUT pour mettre à jour
● DELETE pour supprimer

12. Réponses HTTP
● 200 OK
● 401 Unauthorized
● 500 Internal Server Error
● etc ...

13. Les validations par le webservice
● Validation très fine des données (numéros de téléphone, caractères interdits, etc …)

14. En dernier lieu ...
● le schéma de la base MySQL !

15. Webservice vs
MySQL

16. Webservice
Accès passe partout
Validation des données fine
Versionning
Gestion des événements
Documentation
Plugins présents sans importance
Un accès externe est parfois
compliqué …
Gestion des tables liées
Performance
MySQL

17. API REST
WooCommerce

18. Activation
● Activer l’API REST

19. Auth Endpoint
Oauth
Signature des données + Timestamp
+ authentification
Auth HTTP
Source : woocommerce.github.io

20. Activation
● Générer la paire de clé

21. Activation
● Ne pas oublier les permaliens (erreur 404 sinon)
● La structure personnalisée (par défaut) ne fonctionne pas => nom de l’article

22. Méthodes principales
● Documentation sur GitHub => http://woocommerce.github.io/woocommerce-rest-api-
docs
● La méthode System status donne plein d’informations sur la configuration de
WooCommerce, WordPress, PHP

23. Filtres et pagination
● Ne récupérer que les commandes validées
● Ne récupérer que les 500 premiers produits

24. Exemples
d’utilisation

25. Se simplifier la vie
● Des librairies existent pour de nombreux langages, pour faciliter :
○ authentification
○ gestion des erreurs
○ pagination
○ syntaxe plus parlante / simplifiée

26. Apartée Composer

27. Apartée Composer
● Outil en ligne de commandes
● Disponible sur tout OS exécutant PHP
● Gestion des librairies et de leurs dépendances
● Gestion des versions et compatibilités
● Un site regroupe tous les paquets : packagist.org

28. Apartée Composer
● Automattic propose une librairie :
● > composer require automattic/woocommerce

29. Créer le client
//Autoload de Composer
require __DIR__ . '/vendor/autoload.php';
//Espace de nom de la librairie
use AutomatticWooCommerceClient;

30. Créer le client
//Création du client
$woocommerce = new Client(
'https://wordcamp.org',
'ck_X', //La clé
'cs_X', // Clé secrète
[
'version' => 'wc/v2', //Pour définir la version à utiliser
‘user_agent’ => ‘WordCamp REST API customer’,
]
);

31. Les 4 méthodes REST
● $woocommerce->get(ressource, options);
● $woocommerce->post(ressource, options);
● $woocommerce->put(ressource, options);
● $woocommerce->delete(ressource, options);

32. Gestion des erreurs
● Exception “HttpClientException”
try {
// Mon code
} catch (HttpClientException $e) {
$e->getMessage(); // Message d’erreur.
$e->getRequest(); // La dernière requête.
$e->getResponse(); // La réponse.
}

33. Mettre à jour un prix
$produit = $woocommerce->get( 'products', array(‘id’ => 1258));
$produit->regular_price = 20;
$woocommerce->put(‘products’, $produit);

34. Mettre à jour un prix
try {
$produit = $woocommerce->get( 'products', array(‘id’ => 1258));
} catch (HttpClientException $e) {
echo $e->getMessage(); // Message d’erreur.
}
$produit->regular_price = 20;
try {
$woocommerce->put(‘products’, $produit);
} catch (HttpClientException $e) {
echo $e->getMessage(); // Message d’erreur.
}

35. Créer un produit
$produit = [
'name' => 'Billet WordCamp',
'type' => 'simple',
'regular_price' => '20.00',
'description' => 'Participez au prochain WordCamp',
'images' => [
[
'src' => 'https://wordpress.org/path/to/image.jpg',
'position' => 0,
[...]
$woocommerce->post( 'products', $produit );

36. Appliquer un filtre
● Récupérer les 100 dernières commandes au statut pending

37. Appliquer un filtre
$woocommerce->get(‘orders’, array (‘status’ => ‘pending’, ‘per_page’ => 100));

38. Comment tester
le client REST ?

39. Installer un WooCommerce de test
● Installer WampServer / Xampp
● Télécharger WordPress
● Allez dans le back-office, installer WooCommerce

40. Installer un WooCommerce de test
● Installer WampServer / Xampp
● Télécharger WordPress
● Allez dans le back-office, installer WooCommerce
● Et répéter à chaque test ...

41. Apartée WP-CLI

42. Installer un WooCommerce de test v2
● Installer un hyperviseur de son choix
● Installer Vagrant
● Scripter l’installation d’une machine virtuelle
● Bénéficier des snapshots

43. Vagrant
Vagrant.configure("2") do |config|
config.vm.box = "spartan/aws-dummy"
config.vm.provider "aws"

44. Vagrant
Vagrant.configure("2") do |config|
config.vm.box = "spartan/aws-dummy"
config.vm.provider "aws"
config.vm.provider :aws do |aws, override|
aws.access_key_id = ""
aws.secret_access_key = ""
aws.keypair_name = 'vagrantaws'
aws.ami = ""
aws.region = "eu-central-1"
aws.instance_type = "m3.medium"
[...]
end

45. Vagrant
config.vm.provision "shell", inline: <<-SHELL
apt-get update
apt-get install -y mysql-server mysql-client curl unzip git
apt-get install -y apache2
apt-get install -y php php-mysql php-imap php-intl libapache2-mod-php php-common php-
gd php-pear libgd-tools php-curl php-mcrypt php-mbstring
/etc/init.d/apache2 restart

46. Vagrant
wget https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
php wp-cli.phar core download --path=/var/www/html/wordpress --allow-root --locale=fr_FR
php wp-cli.phar config create --path=/var/www/html/wordpress --locale=fr_FR [...]
php wp-cli.phar core install --url=$url/wordpress --title=Example --admin_user=admin --
admin_password=0123456789 --admin_email=wp@wp.com --skip-email [...]
php wp-cli.phar plugin install woocommerce --activate [...]
php wp-cli.phar option update siteurl wordpress [...]

47. Tests unitaires
du client REST
Comment rédiger des tests unitaires
quand une méthode appelle un
webservice ?

48. PHPUnit
class WSTest extends PHPUnit_Framework_TestCase
{
public function testget()
{
$produit = $woocommerce->get( 'products', array(‘id’ => 1258));
$this->assertEquals(MONMODELE, $produit);
}
}

49. Comment tester
QUE le client
REST ?

50. Simulacre d’objet / Mock Object
● Reproduire le comportement du webservice, de manière contrôlée et reproductible
● Mock de l’objet $woocommerce
● Un framework bien pratique : Phake

51. Phake - mise en bouche ...
>composer require --dev phunit/phpunit
>composer require --dev phake/phake
Et pour la suite : RTFM ;)

52. Des questions ?
@Vaisonet
Maxime Varinard