API pour lister ses prestations

API pour lister ses prestations

Si vous êtes un membre de Bulldoz, vous pouvez lister toutes vos prestations via notre API.

Attention, l’API retourne au maximum 1000 prestations.

Utilisation de l’API

Pour obtenir la liste de vos prestations, vous devez envoyer une requête POST à l’adresse :

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

Avec en paramètre :

  • CleApi : La clé API du rédacteur.
  • IdentifiantClient (facultatif) : Retournera uniquement les prestations pour ce client.
  • Type (facultatif) : Retournera uniquement les prestation de ce type (voir les valeurs possibles plus bas).
  • Statut (facultatif) : Retournera uniquement les prestations ayant ce statut (voir les valeurs possibles plus bas).
  • DateDebut (facultatif) : Retournera uniquement les prestations ayant été commandé après cette date.
  • DateFin (facultatif) : Retournera uniquement les prestations ayant été commandé avant cette date.
  • MotCle (falcultatif) : Retournera uniquement les prestation dont le libellé contient un ou plusieurs mots-clé (les mots-clés doivent être séparés  par des « + », par exemple « redacteur+web »).
  • NombreResultatsMaximum (facultatif) : Retournera au maximum le nombre de résultats

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 commande a réussi :

  • Retour : « Ok ».
  • Message : « Ok, la liste des prestations a bien été retournée. » (en unicode).
  • Prestation : la liste des prestations. Chaque prestation dispose des informations suivantes :
    • IdentifiantPrestation : un numéro unique d’identification de la prestation.
    • IdentifiantClient : le numéro unique d’identification du client qui a commandé cette prestation.
    • Libelle : le nom de la prestation.
    • DateCommande : La date a laquelle la commande a été passée.
    • Type : le type de la prestation (voir les valeurs possibles plus bas)
    • Statut : le statut de la prestation (voir les valeurs possibles plus bas).
    • PrixHt : le prix Hors Taxes de la prestation.

Exemple de retour en cas de réussite :

{« Retour »: »Ok », »Message »: »Ok, votre demande a bien \u00e9t\u00e9 retourn\u00e9e. », « Commande »:[{« Identifiant »: »123″, « NumeroClient »: »456″, »Type »: »RedactionTexte », …},… ]}

Statut d’une prestation

Le statut d’une prestation évolue en fonction de son évolution :

  • EnAttenteReponsePrestataire : La prestation doit être accepté  ou refusé par le rédacteur.
  • PrestataireNAPasRepondu : Le temps n’a pas donné de réponse et le délai pour livrer est dépassé.
  • RefuseParPrestataire : La prestation a été refusé par le prestataire.
  • EnCoursDeRealisation : Le rédacteur a accepté la prestation et est en train de rédiger le texte.
  • DateLimiteLivraisonDepasse : Le rédacteur n’a pas livré bien que la date de livraison soit dépassée.
  • ValideAutomatiquement : La prestation a été validé automatiquement par Bulldoz.
  • EnAttenteValidationClient : Le client doit valider le texte livré.
  • Valide : La prestation a été validé par le client
  • Annule : La prestation a été annulée par le client.

Type de prestation

Il y a deux types de prestation :

  • RedactionTexte : Le client a commandé la rédaction d’un texte.
  • VerificationPlagiat : Le client a commandé la vérification du plagiat d’un texte.

Exemple de code PHP utilisant l’API :

$tParametreEntrant = array(

‘CleApi’=>’0123456789Abc’,
‘IdentifiantClient’=>’33696’,
‘Statut’=’EnCoursDeRealisation’
);

$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(« http://www.bulldoz.net/api/apiListerPrestation.php », false, $context);

$RetourApi = json_decode($RetourApi, 1);

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