31,003
edits
Module Web Services API REST (développeur): Difference between revisions
Jump to navigation
Jump to search
m
Module Web Services API REST (développeur) (view source)
Revision as of 21:23, 2 February 2023
, 3 years agono edit summary
(→Vidéos sur le sujet (documentation utilisateurs): Mise en page) Tag: 2017 source edit |
mNo edit summary Tag: 2017 source edit |
||
| Line 68: | Line 68: | ||
Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com. | Pour ce faire, il existe plusieurs méthodes. Voici un morceau de code opérationnel pour appeler une API, mais il existe également des librairies qui simplifie le travail, telles que phphttpclient.com. | ||
< | <syntaxHighlight lang="php"> | ||
function CallAPI($method, $apikey, $url, $data = false) | function CallAPI($method, $apikey, $url, $data = false) | ||
{ | { | ||
| Line 112: | Line 112: | ||
return $result; | return $result; | ||
} | } | ||
</ | </syntaxHighlight> | ||
Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins. | Ce n'est qu'un exemple, ce n'est pas sécurisé, cela ne prend pas en compte les codes erreurs mais vous pouvez le modifier et l'adapter à vos besoins. | ||
| Line 130: | Line 130: | ||
< | <syntaxHighlight lang="php"> | ||
// Récupérer la liste des produits | // Récupérer la liste des produits | ||
$listProduits = []; | $listProduits = []; | ||
| Line 143: | Line 143: | ||
} | } | ||
} | } | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* récupérer les 10'000 premiers produits triés par leur id dans la base | * récupérer les 10'000 premiers produits triés par leur id dans la base | ||
| Line 150: | Line 150: | ||
< | <syntaxHighlight lang="php"> | ||
// Créer un produit | // Créer un produit | ||
$ref = "ma_reference_produit_X203ZZ"; | $ref = "ma_reference_produit_X203ZZ"; | ||
| Line 159: | Line 159: | ||
$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct)); | $newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct)); | ||
$newProductResult = json_decode($newProductResult, true); | $newProductResult = json_decode($newProductResult, true); | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait : | * avant de créer un produit, il peut être sage de vérifier qu'il existe. En reprenant le premier exemple, cela fait : | ||
< | <syntaxHighlight lang="php"> | ||
// ma référence | // ma référence | ||
$ref = "ma_reference_produit_X203ZZ"; | $ref = "ma_reference_produit_X203ZZ"; | ||
| Line 191: | Line 191: | ||
} | } | ||
} | } | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple. | * je regarde si la référence de mon article existe dans le tableau créé dans le premier exemple. | ||
| Line 199: | Line 199: | ||
< | <syntaxHighlight lang="php"> | ||
// créer une commande avec 2 articles | // créer une commande avec 2 articles | ||
| Line 243: | Line 243: | ||
$newCommandeResult = json_decode($newCommandeResult, true); | $newCommandeResult = json_decode($newCommandeResult, true); | ||
} | } | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant | * $clientDoliId vaut l'id du client dans la base doli. Soit vous le connaissez, soit vous pouvez le chercher auparavant | ||
| Line 249: | Line 249: | ||
< | <syntaxHighlight lang="php"> | ||
// Valider une commande | // Valider une commande | ||
$newCommandeValider = [ | $newCommandeValider = [ | ||
| Line 257: | Line 257: | ||
$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider)); | $newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider)); | ||
$newCommandeValiderResult = json_decode($newCommandeValiderResult, true); | $newCommandeValiderResult = json_decode($newCommandeValiderResult, true); | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate".<br/> | * on voit dans cet exemple, en avant dernière lignes, on a : $apiUrl."orders/".$newCommandeResult."/validate".<br/> | ||
| Line 263: | Line 263: | ||
< | <syntaxHighlight lang="php"> | ||
// chercher si le client existe dans la base | // chercher si le client existe dans la base | ||
$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array( | $clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array( | ||
| Line 273: | Line 273: | ||
) | ) | ||
), true); | ), true); | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* limit => 1 pour ne renvoyer que 1 client | * limit => 1 pour ne renvoyer que 1 client | ||
| Line 280: | Line 280: | ||
< | <syntaxHighlight lang="php"> | ||
//client n'existe pas. le crée puis on récupère son id | //client n'existe pas. le crée puis on récupère son id | ||
$newClient = [ | $newClient = [ | ||
| Line 291: | Line 291: | ||
$newClientResult = json_decode($newClientResult, true); | $newClientResult = json_decode($newClientResult, true); | ||
$clientDoliId = $newClientResult; | $clientDoliId = $newClientResult; | ||
</ | </syntaxHighlight> | ||
Commentaires : | Commentaires : | ||
* client => 1 car c'est un client (et pas un fournisseur) | * client => 1 car c'est un client (et pas un fournisseur) | ||