iPromo

API Developpeur - 1.0 - 23/02/10 - contact@ipromo-app.com

A) Principe

1. Présentation

L'API développeur vous permet d'importer vos produits directement depuis votre boutique en ligne, sans recourir à notre interface d'administration. Pour cela votre application doit génerer un fichier XML, et communiquer son adresse URL à notre serveur pour traitement.

2. Description du processus

Votre site va génerer, via un script (PHP, ASP, Perl, …) un fichier reprenant l'ensemble des informations nécessaires au fonctionnement de votre boutique iPromo

• Informations générales sur la boutique

• Logo

• Liste des produits à integrer

• URL des photos des produits
  

Une fois ce fichier géneré, votre script doit appeler une adresse URL (file_get_contents() en PHP apr exmeple) avec comme variable l'adresse de votre fichier XML précedemment créé. Notre serveur va traiter toutes les informations, de l'authentification au téléchargement et redimensionnement de vos photos. Un code de réponse est alors transmis en retour.

Attention : si vous utilisez l'API, tous les produits et modifications effectuées via l'interface d'administration classique seront écrasées et irrecuperable. Tous les articles et photos sont regenerés à chaque appel à l'API. Il est conseillé d'utiliser soit l'API soit l'interface d'administration, et de limiter au maximum l'utilisation des deux en simultané.

B) Le fichier XML

1. Exemple

<?xml  version="1.0" encoding="iso-8859-1" ?>
<ipromo  version="1.0">
<test>test</test>
<login>identifiant@ipromo.com</login>
<password>NUMERODECERTIFICAT</password>
<logo>http://www.adresse.url/devotre/logo.jpg</logo>
<description>Description  rapide de votre activité</description>
<url>http://www.adresse-url.com/</url>
<email>contact@votreboutique.com</email>
<tel>0123456789</tel>
<signature>472d14764a789b4d9f5a175df4c92284</signature>
<date>1266930291</date>

<items>
		<product ordre="1">
			<cat>01</cat>
			<ref>REFERENCE</ref>
			<titre><![CDATA[Article  n°1]]></titre>
			<prix>11952</prix>
			<prix_promo>10865</prix_promo>
		    <port>695</port>
			<img>http://www.adresse.com/images/votreimage.jpg</img>
			<img_2>http://www.adresse.com/images/votreimage2.jpg</img_2>
			<img_3>http://www.adresse.com/images/votreimage3.jpg</img_3>
			<link>http://www.adresse.com/fiche-produit.php</link>
			<description><![CDATA[description  de votre <b>Produit</b>]]></description>
		</product>
</items>
</ipromo>

2. Détails des balises

Vous devez alors enregistrer votre fichier en local (le nom n'a pas d'importance) à un emplacement accessible depuis le Web (ce fichier va être téléchargé par notre serveur)

C) Transmission du fichier

Votre script doit ensuite appeler l'URL suivante : http://api.ipromo-app.com/api/api.php?flux=http:/www.maboutique.com/flux/iphone.xml

Remplacer la variable "flux" par l'adresse URL complète du flux que vous venez de créer

D) Réponse du serveur

Notre serveur va ensuite traiter votre flux et renverra un message de retour contenant un code d'erreur, et la signature pour controler de l'intégrité des données

<result>
		<code>0</code>  
		<description>Pas d'erreur</description>  
		<signature>472d14764a789b4d9f5a175df4c92284</signature> 
</result>  

1. Code de retour

E] Exemple complet (PHP)

<?php

// Paramètres de base

$time = time();
$cert = 'B6B3C136F4C7B67FE912B2BD3C99758D'; // certificat à recuperer dans l'administration
$login = 'contact@maboutique.com';
 // votre identifiant

// Entete XML du flux, en ISO-8859-1

$flux = '<?xml version="1.0" encoding="iso-8859-1" ?>';

$flux .= '<ipromo version="1.0">';
$flux .= '<test>test</test>';

// informations d'identification

$flux .= '<login>'.$login.'</login>';
$flux .= '<password>'.$cert.'</password>';

// paramètres de la boutique

$flux .= '<logo>http://www.maboutique.com/images/iphone.jpg</logo>';
$flux .= '<description>Description complète de ma boutique</description>';
$flux .= '<url>http://www.maboutique.com/</url>';
$flux .= '<email>contact_iphone@maboutique.com</email>';
$flux .= '<tel>0123456789</tel>';

// verification de l'integrité du flux

$flux .= '<signature>'.md5($login.$cert.$time).'</signature>';
$flux .= '<date>'.$time.'</date>';

// début de la liste des produits

$flux .= '<items>';

$res = mysql_query("SELECT * FROM produits ORDER BY ordre LIMIT 10"); // limiter suivant le nombre de produit de votre offre, les suivants seront ignorés

$h = 1;
$mx = mysql_num_rows($res);

while($h != $mx+1){ // boucle executée pour chaquert article sélectionnée depuis la base de données

    $rec = mysql_fetch_array($res);

    $flux .= '<product ordre="'.$h.'">'; // ordre d'affichage des produits

    $flux .= '<cat>01</cat>'; // numéro de la catégorie (voir annexe I)
    $flux .= '<ref>'.$rec['reference_produit'].'</ref>'; // reference interne de votre produit
    $flux .= '<titre><![CDATA['.htmlentities($rec['titre_produit']).']]></titre>'; // titre avec accents sous forme d'entitées

    // tarif x 100 (pas de séparateur de virgule)
    $flux .= '<prix>'.($rec['prix_normal']*100).'</prix>';
    $flux .= '<prix_promo>'.($rec['prix_promotion']*100).'</prix_promo>';
    $flux .= '<port>'.($rec['port']*100).'</port>';
  

    // url des images du produits
    $flux .= '<img>http://www.maboutique.com/photo/mareference/photo1.jpg</img>';
    $flux .= '<img_2>http://www.maboutique.com/photo/mareference/photo2.jpg</img_2>';
    $flux .= '<img_3>http://www.maboutique.com/photo/mareference/photo2.jpg</img_3>';

    $flux .= '<link><![CDATA[http://www.maboutique.com/monproduit.html]]></link>';

    // description au format HTML
    $flux .= '<description><![CDATA['.$rec['description_produit'].']]></description>';

    $flux .= '</product>';
    $h++;

}

$flux .= '</items>';
$flux .= '</ipromo>';


// ecriture du flux dans un fichier local
$fp = fopen('iphone.xml', 'w+');
fputs($fp, $flux, strlen($flux));
fclose($fp);

// envoi de l'adresse du flux vers iPromo
$dump = file_get_contents('http://www.ipromo-app.com/api/api.php?flux='.urlencode("http://www.maboutique.com/iphone.xml"));

// traitement eventuel du résultat
echo $dump;

?>

Annexe I