API pour commander un article sponsorisé

12 mai 2023

Dernière mise à jour le 12/05/2023, par François Tréca

Si vous êtes membre de Bulldoz, vous pouvez commander un article sponsorisé à un éditeur via l’API.

Utilisation de l’API

Pour passer une commande d’article sponsorisé, vous devez envoyer une requête POST à l’adresse :

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

Avec en paramètre :

CleApi : Votre clé api.
MotDePasse : Votre mot de passe.
IdentifiantCommande : L’identifiant de la commande, il vous permettra d’avoir des informations sur l’état de la commande. Chaque commande doit avoir un identifiant différent.
IdentifiantApiEditeur : L’identifiant API de l’éditeur à qui vous commandez l’article.
NomDeDomaine : Le nom de domaine du site sur lequel vous souhaitez publier l’article (exemple : monsite.fr)
Prix : Le prix que vous payerez pour cette prestation.
Titre : Le titre de l’article.
EstTexteFournit : 1 si vous fournissez le texte, 0 si vous souhaitez que l’éditeur rédige le texte.
Texte (facultatif) : Le texte que vous fournissez
NbMots (facultatif) : Le nombre de mots à rédiger.
Url (facultatif) : L’URL du lien à placer dans le texte.
Ancre (facultatif) : L’ancre du lien à placer dans le texte.
Brief (facultatif) : Le brief pour la rédaction du texte.
EstPublicationDesQuePossible : 1 si l’article doit être publié dès que possible, 0 sinon.
DateLivraisonSouhaitee (facultatif) : La date de livraison souhaitée, au format « AAAA-MM-JJ HH:MM ». Si non renseignée, ce sera 1 semaine par défaut.
Test (facultatif) : Mettez 1 si vous souhaitez que l’API retourne un résultat normal, mais que la commande ne soit pas passée.

A noter :

Si vous fournissez le texte, alors mettez EstTexteFournit à 1. Dans ce cas, le paramètre Texte est obligatoire.
Si vous souhaitez que l’éditeur rédige le texte, alors mettez EstTexteFournit à 0. Dans ce cas, les paramètres NbMots, URL et Ancre sont obligatoires.

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, votre demande a été bien prise en compte. » (en unicode).

{ "Retour" : "Ok", "Message" : "Ok, votre demande a \u00e9t\u00e9 bien prise en compte." }

Exemple de code PHP utilisant l’API :

A noter : en local, l’API retournera probablement un message d’erreur. Veuillez tester sur un serveur web.

<?php
$tParametre = array(
'CleApi'=>'VOTRE_CLE_API_123',
'MotDePasse'=>'VOTRE_MOT_DE_PASSE',
'IdentifiantCommande'=>'VOTRE_ID_COMMANDE_123',
'IdentifiantApiEditeur'=>'ID_DE_VOTRE_PRESTATAIRE',
'NomDeDomaine'=>'super-site-editeur.fr',
'EstTexteFournit'=>'0',
'Prix'=>'99',
'Titre'=>'Histoire des présidents français',
'NbMots'=>'500',
'Url' => 'https://www.la-france.fr/presidents-francais',
'Ancre' => 'cliquez ici pour avoir plus de détails',
'Brief'=>'Merci de rédiger un texte sur les différents présidents français',
'EstPublicationDesQuePossible' => '1',
'Test'=>1
);

$postdata = http_build_query($tParametre);
$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/apiCommanderArticleSponso.php', false, $context);
$RetourApi = json_decode($RetourApi, 1);
print_r ($RetourApi); ?>

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 commande soit envoyée.