API pour valider une commande

API pour valider une commande

Si vous êtes membre de Bulldoz, vous pouvez commander une prestation via une API. Une fois que la prestation est terminée, vous pouvez la valider (ou pas) via une API.

Utilisation de l’API

Pour valider une prestation (ou pas), vous devez envoyer une requête POST à l’adresse :

https://www.bulldoz.net/api/apiValiderPrestation.php

Avec en paramètre :

  • CleApi : La clé API de la personne de l’entreprise qui demande la prestation.
  • IdentifiantCommande : L’identifiant de la commande que vous avez donné lors de la commande.
  • Validation : Mettre « 1 » si vous validez la prestation. Mettre « 0 » si vous ne la validez pas.
  • Commentaire (facultatif) : Votre commentaire sur la prestation.
  • Test (facultatif) : Mettre « 1 » si vous voulez simuler le fonctionnement de l’API sans enregistrer la validation.

Retour de l’API

L’API retourne un tableau JSON contenant le résultat de l’API.

Si la commande a échoué :

  • Retour : « Erreur »
  • NumeroErreur : L’identifiant de l’erreur.
  • Message : Un message expliquant la cause de l’erreur (en unicode).

Exemple de retour avec erreur :

{« Retour »: »Erreur », »NumeroErreur »: »1-0″, »Message »: »Vous n’avez pas renseign\u00e9 le param\u00e8tre CleApi »}

Si la prestation n’est pas terminée :

  • Retour : « NonTerminee »
  • Message : « La prestation n’est pas encore terminée. » (en unicode).

Exemple de retour avec erreur :

{« Retour »: »NonTerminee », »Message »: »La prestation n’est pas encore termin\u00e9\u00e9. »}

Si la commande a réussi, mais que la prestation n’est pas terminée :

  • Retour : « Ok ».
  • Message : Un message expliquant le retour (en unicode).

Exemple de retour en cas de réussite :

{« Retour »: »Ok », »Message »: »La prestation n’a pas \u00e9t\u00e9 valid\u00e9e. Le prestataire va recommencer la prestation. »}

Exemple de code PHP utilisant l’API :

$tParametreEntrant = array(

‘CleApi’=>’0123456789Abc’,
‘IdentifiantCommande’=>’33696’,
‘Validation’=>’1’,
‘Commentaire’=>’Bon travail, merci’,
‘Test’=>’1’

);

$postdata = http_build_query($tParametres);

$opts = array(‘http’ =>
array(
‘method’ => ‘POST’,
‘header’ => ‘Content-type: application/x-www-form-urlencoded’,
‘content’ => $postdata
)
);

$context = stream_context_create($opts);

$RetourApi = file_get_contents(« https://www.bulldoz.net/api/apiValiderPrestation.php », false, $context);

$RetourApi = json_decode($RetourApi, 1);

echo $RetourApi[‘Retour’]; // Affiche « Ok », « Erreur » ou « NonTerminee »

Faire un test

Pour faire un test de l’API, utilisez le paramètre ‘Test’ avec la valeur 1, ce qui permettra d’obtenir un comportement normal de l’API sans que la validation soit enregistrée.