Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce

Transcription

1 Note d application Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce Version 1.0.2

2 Introduction Objet Reactivpub, plateforme d affiliation basée sur la technologie R-ADServer développée par la société R, permet de mettre en relation des affiliés (ou diffuseurs : sites internet souhaitant rentabiliser leur espace publicitaire), et des sites annonceurs souhaitant vendre ou promouvoir leurs produits. Il existe différents modèles techniques et économiques de diffusion publicitaires qui divergent notamment au niveau de leur mise en œuvre. Ce document expose les recommandations techniques de R pour l intégration des marqueurs (ou tags) de la plateforme de diffusion de Reactivpub dans le cadre de campagnes publicitaires de type vente, pour un site basé sur oscommerce 2.2-MS2 Fr ou oscommerce 2.2RCA. A qui s adresse ce document? Ce document est destiné aux webmasters, administrateurs ou développeurs souhaitant utiliser la technologie Reactivpub dans leur site internet basé sur oscommerce. Avertissements oscommerce étant un produit que vous pouvez avoir modifié pour vos propres besoins, nous vous conseillons vivement : - d effectuer des copies de sauvegarde des fichiers concernés par les modifications décrites dans ce document, - d effectuer ces modifications tout d abord sur une plateforme de développement afin d en vérifier le bon fonctionnement dans votre configuration, avant passage en production. Malgré tout le soin apporté à sa vérification, ce document peut comporter certaines erreurs. Nous vous invitons à nous transmettre toute remarque ou commentaire à l adresse production@r-advertising.com Les informations contenues dans ce document sont susceptibles d être modifiées sans préavis. Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 2

3 Principe Généralités Le dispositif de tracking Reactivpub est compatible avec les principales solutions de paiement du marché. Deux tags doivent êtres mis en place dans le site annonceur : un tag de marquage de la transaction (lead ou vente), et un tag de validation de la transaction. Tag de marquage de la transaction : tracking.php L appel de ce premier tag doit être placé avant l appel au dispositif de paiement, dans la dernière page Web visualisée par le visiteur (par exemple dans la page de confirmation de commande). La forme générale de ce tag est : <iframe src=" params=p1 P2&id_transaction=P3&track=P4&prix=P5 width="1" height="1" marginwidth="0" marginheight="0" frameborder="0" scrolling="no"></iframe> Dans ce tag : - P1 et P2 : représentent des valeurs fournies par Reactivpub spécifiques à votre campagne. Ces valeurs peuvent être récupérées dans la rubrique «tag annonceur» de votre campagne sur l interface d administration Reactivpub, ou fournies par votre gestionnaire de compte. - P3 : représente un identifiant unique de la transaction qui débute. Typiquement, il peut s agir d un numéro de commande, ou d une concaténation de plusieurs informations (numéro de commande + montant de la commande + date de la commande ) pourvu que sa valeur soit unique. - P4 : représente la valeur de l adresse du client effectuant la transaction (l achat) - P5 : représente le prix total de la transaction Important : tous les paramètres (P1 à P5) doivent être renseignés lors de l appel à tracking.php Exemple : <iframe src=" &id_transaction=ABCDE12345&track=test@test.fr &prix= width="1" height="1" marginwidth="0" marginheight="0" frameborder="0" scrolling="no"></iframe> Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 3

4 Tag de validation de la transaction : tracking_transaction.php L appel de ce second tag doit être fait dans un script PHP du site, une fois le paiement effectué. L appel peut être par exemple être fait dans le script de validation de commande invoqué par le dispositif de paiement, ou dans un script chargé de l envoi d un de confirmation de commande. Contrairement au premier tag, l appel de ce tag peut être fait en dehors de tout navigateur. La forme générale de ce tag est : params=p1 P2&id_transaction=P3 Les paramètres P1, P2 et P3 doivent avoir les mêmes valeurs que lors de l appel à tracking.php. Important : tous les paramètres (P1 à P3) doivent être renseignés lors de l appel à tracking_transaction.php Exemple : params= &id_transaction=ABCDE12345Z Remarques : - l appel du tag tracking_transaction.php a pour effet d enregistrer la transaction dans l état «en attente» dans votre interface d administration Reactivpub. Vous pourrez alors l accepter ou la refuser définitivement. - L appel du tag tracking_transaction.php ne doit être fait que si le paiement est accepté. Dans le cas contraire, ce tag ne doit tout simplement pas être appelé. Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 4

5 Intégration des tags Etape 1 : placement du tag tracking.php Dans le script «catalog\checkout_confirmation.php», placer le code suivant juste avant la balise </body> (en bas du script, vers la ligne 380) en prenant soin de remplacer les valeurs des paramètres P1 et P2 par ceux correspondant à votre campagne : <?php // Récupération de l id de session et de la date $reac_date = date("dmyhis"); $_SESSION["date"] = $reac_date; $reac_session_id = tep_session_id($sessid); $reac_session_id.= "-".$reac_date; // Nettoyage $reac_session_id = str_replace(" ", "", $reac_session_id = str_replace("/", "", $reac_session_id = str_replace(";", "", // Récupération de l adresse mail du client $reac_track = $order->customer[' _address']; // Récupération du prix des articles (montant transaction) $reac_prix = $order_total_modules->total(); $reac_prix = round($reac_prix, 2); // Génération de l appel du premier tag // (Remplacer P1 P2 par valeurs spécifiques à la campagne) $reac_iframe = '<iframe '; $reac_iframe.= 'src=" $reac_iframe.= 'scripts/tracking.php?params=p1 P2'; $reac_iframe.= '&id_transaction='.$reac_session_id; $reac_iframe.= '&track='.$reac_track; $reac_iframe.= '&prix='.$reac_prix.'" '; $reac_iframe.= ' width="1" height="1" marginwidth="0" '; $reac_iframe.= ' marginheight="0" frameborder="0" '; $reac_iframe.= ' scrolling="no">'; $reac_iframe.= '</iframe>'; // Affichage du tag echo $reac_iframe;?> Remarque : ce code détermine la valeur du paramètre P3 (id_transaction) comme la concaténation de l ID de la session PHP du visiteur et la date courante. Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 5

6 Etape 2 : méthode «order_total ->total()» Editer le script «catalog\includes\classes\order_total.php» et insérer le code suivant à la fin du fichier, juste avant l accolade fermant la définition de la classe order_total, c'est-à-dire avant :?> Code à insérer : // // Définition de la méthode order_total->total() // Entrée : rien // Sortie : retourne le total de la commande // // Reactivpub // function total() { $reac_tot = 0; if (is_array($this->modules)) { reset($this->modules); if ($GLOBALS['ot_shipping']->enabled) { // Récupération des frais $size = sizeof($globals['ot_shipping']->output); for ($i=0; $i<$size; $i++) { $reac_tot += $GLOBALS['ot_shipping']->output[$i]['value']; if ($GLOBALS['ot_tax']->enabled) { // Récupération des taxes $size = sizeof($globals['ot_tax']->output); for ($i=0; $i<$size; $i++) { $reac_tot += $GLOBALS['ot_tax']->output[$i]['value']; if ($GLOBALS['ot_subtotal']->enabled) { // Récupération du sous total $size = sizeof($globals['ot_subtotal']->output); for ($i=0; $i<$size; $i++) { $reac_tot += $GLOBALS['ot_subtotal']->output[$i]['value']; return $reac_tot; Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 6

7 Etape 3 : placement du tag tracking_transaction.php Editer le fichier «catalog\checkout_process.php» et ajouter le code suivant, en haut du script et juste en dessous de la 1 ière instruction «include» (vers la ligne 13) : // Récupération de l id de session et de la date $reac_date = $_SESSION["date"]; $reac_session_id = tep_session_id($sessid); $reac_session_id.= "-".$reac_date; // Nettoyage $reac_session_id = str_replace(" ", "", $reac_session_id = str_replace("/", "", $reac_session_id = str_replace(";", "", // Appel du tag (serveur à serveur) // (Remplacer P1 P2 par valeurs spécifiques à la campagne) $reac_url = " $reac_url.= "tracking_transaction.php?"; $reac_url.= "params=p1 P2"; $reac_url.= "&id_transaction=". $reac_session_id; file($reac_url); tep_session_unregister('orders_total'); tep_session_unregister('orders_id'); Remarque : l instruction «file(..)» ne fonctionne avec une URL que si l'option PHP «fopen wrappers» a été activée (php.ini : allow_url_fopen = On). Reportez-vous à pour plus de détails. Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 7

8 Fin de l opération Tests et validation Une fois les modifications apportées, vous devez effectuer quelques transactions de tests, par exemple : - Ajoutez des produits au panier, confirmez la commande, puis effectuez un paiement qui sera accepté - Ajoutez des produits au panier, confirmez la commande, puis effectuez un paiement qui sera refusé Prenez soin de noter, pour chaque transaction, le montant de la commande et l adresse utilisé. Au cours de ces tests aucune erreur ou avertissement PHP ou Javascript ne doivent remonter. Connectez-vous ensuite sur l interface d administration Reactivpub et vérifiez que les transactions de tests pour lesquels le paiement a été accepté apparaissent bien dans la liste des transactions en attente de validation. Vous pourrez alors les refuser pour les faire disparaître de la liste. Notez que les transactions de test peuvent mettre un certain temps pour apparaitre dans la liste des transactions à valider. Si vous le souhaitez, contactez votre gestionnaire de compte afin qu il vérifie pour vous le bon enregistrement des transactions. Annonceurs : recommandations pour l intégration des tags Reactivpub dans oscommerce 8