Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Principe général

 

 

Le javascript SPREAD permet :

  •  de mettre en place les widgets sur votre site web (exemples ci-dessous)
  •  de faire remonter les créations de compte dans la CRM SPREAD
  •  de faire remonter les commandes dans la CRM SPREAD

 

La CRM SPREAD permet ensuite de regrouper les informations commerciales, sociales et comportementales de votre base clients / prospects pour mener des actions spécifiques (fidélisation, animation, relance etc...)

 

Le javascript de SPREAD a été conçu pour ne pas ralentir le temps d’affichage de vos pages (fonctionnement asynchrone) et ainsi vous garantir un fonctionnement transparent.

 

JAVASCRIPT 1 - Widgets

 

Le javasript ci-dessous est à insérer sur toutes les pages du site, juste avant la balise </body>

Sa fonction principale est de permettre de piloter les widgets depuis le backoffice SPREAD. Associé aux javascript de création de compte et de remontée de commandes, il permet également de faire remonter ces infos dans la CRM SPREAD.

 

Deux possibilités pour intégrer ce JavaScript :

  • Méthode 1 : Le JavaScript est ajouté uniquement lorsque votre page est chargée (plus rapide)
  • Méthode 2 : Le JavaScript est ajouté même si le contenu de votre page n'est pas fini d'être chargé (plus lent)

 

Code Block
languagejs
titleMéthode 1
 <script type="text/javascript">

    var publicKeySb = "????????????????";  /*à remplacer par votre clé d’API Publique*/ 
    var sbsetcookie = true; /*facultatif : uniquement si vous utilisez le parrainage*/
    function loadSpreadTracker(){ window.domLoadEventFired=true;var e=document.createElement("script");e.type="text/javascript";e.async=true;e.charset="UTF-8";e.id="spread-tracker";e.src="//static-sb.com/js/sb-tracker.js";document.body.appendChild(e) } if(window.addEventListener) { window.addEventListener("load",loadSpreadTracker,false) } else if(window.attachEvent) { window.attachEvent("onload",loadSpreadTracker) } else { window.onload=loadSpreadTracker }



 </script>
Code Block
languagejs
titleMéthode 2
 <script type="text/javascript">

	var publicKeySb = "????????????????" ;  /*à remplacer par votre clé d’API Publique*/ 
    var sbsetcookie = true; /*facultatif : uniquement si vous utilisez le parrainage*/
	var iproto = (("https:" == document.location.protocol) ? "https://" : "http://");

	document.write(unescape("%3Cscript src='" + iproto + "static-sb.com/js/sb-tracker.js' charset='UTF-8' type='text/javascript'%3E%3C/script%3E"));	

</script>
Note
titleAttention

N'intégrez pas directement le fichier "sb-tracker.js" sur votre site sans quoi vous ne pourrez pas bénéficier des mises à jour que nous réalisons régulièrement

JAVASCRIPT 2 -  Remontée de commandes

 

Le traqueur de commande permet d’intégrer automatiquement les commandes et les clients dans la CRM de SPREAD (à chaque fois qu’un de vos clients passe une commande).

 

Le code suivant est à insérer sur la page de confirmation de commande, en plus du tag sur toutes les pages (de préférence avant).

 

 

 

Code Block
<script type="text/javascript">

	var siteid = "????????????????" ; /*à remplacer par votre clé d’API Publique*/              
    var sbactionOrder = 1;			
    var spreadOrderEmail = "john@doe.com" ; 		
    var spreadOrderAmount = 13.30 ; 				
    var spreadOrderFirstname = "John" ; /* seulement si le nom et le prénom sont séparés*/
    var spreadOrderName = "Doe" ; 	/* «John Doe» si pas séparés */
    var spreadIdOrder = "1340" ;  /* ID de la commande */
    var spreadOrderOptin = 1 ; 
    var spreadOrderState = 20 ; /* 10, 20, 50, 100, 0 */
    var ordertest = 0 ;

    var sbOrderNum = "F2013-9743"; /* 2ème numéro de facture possible */

    /* Champs optionnels */
    var spreadOrderBirthday = "1975-12-25"; 
    var spreadOrderGender = "male";  /* ou «female» */
    var spreadOrderAddress = "8, rue de la place";
    var spreadOrderCp = "76000";
    var spreadOrderCity = "Rouen";
    var spreadOrderCountry = "FR";  /* pays au format ISO : FR, ES, IT, DE... */
    var spreadOrderTel = "0235000000";	
    var spreadOrderMobile = "0690870089";
    var spreadOrderFonction = "CEO";
    var spreadOrderCompany = "My Company";

    /* Champs personnalisables */
    /* 7 et 8 correspondent aux id des champs personnalisables que vous trouvez dans votre backoffice, menu Paramétrage > Tracker */
    var sbCustomFields = {custom_fields : {7 : "Professionnel", 8 : "Cosmétique"}}; 

    /* Tags */
    var add_tag = "tag1, tag2, tag3";
    var del_tag = "tag4";

</script>
Info

Pour retrouvez les identifiants de vos champs personnalisables, rendez-vous dans le paramétrage du tracker.

 

Informations obligatoires

 

Les seules informations obligatoires sont :

  •  le «orderemail» qui est l’adresse email du client
  •  le «siteid» qui est la clé d’API du site et peut être trouvé dans le tableau de bord SPREAD de la boutique ( Paramétrage > Clé API). Si vous avez mis le javascript sur toutes les pages, avec le  «publicKeySb» vous n’avez pas besoin de le préciser.
  •  le «sbactionOrder» qui permet de savoir qu’il s’agit d’une commande 

 

 

 Gestion de l’idorder

La valeur «idorder» est l’identifiant unique de la commande sur la boutique. La première fois que cet identifiant est utilisé, la commande est enregistrée dans la CRM. Si l’identifiant de commande est présenté une deuxième fois, les données sont mises à jour.

Cet identifiant est particulièrement utile pour changer l’état de la commande (l’annuler ou la mettre à expédier).

 

 

Gestion de l’état de la commande (orderstate)

Si vous avez indiqué l’ «idorder» vous allez pouvoir faire évoluer l’état de la commande au fur et à mesure avec la variable orderstate :

  •  10     :    enregistrée
  •  20     :    payée
  •  50     :    expédiée
  •  100   :    reçue
  •  0       :    annulée

 

sbOrderNum est optionnel et peut être utilisé pour passer un numéro de facture différent de l’ID de commande.

 

 

Gestion des champs optionnels

Il est possible de faire remonter l'anniversaire, le sexe, l’adresse, le code postal, la ville, le pays, le numéro de téléphone (portable et fixe) du client. Egalement sa fonction et son entreprise pour le BtoB (voir le détail des variables pour le format).  

Gestion des champs personnalisables

Avec les champs personnalisables, il est possible d’insérer des infos spécifiques dans la CRM SPREAD. Chacun de vos champs personnalisables possèdent un identifiant unique qui permet de les utiliser dans le tracker. Vous pouvez retrouver ces identifiants dans le paramétrage du tracker.

 

Exemple :

Code Block
languagejs
var sbCustomFields = {custom_fields : {390 : "Professionnel", 391 : "Boutique US"}};
 

Image Removed

 

 Gestion des tags

Avec les tags vous pouvez ajouter des informations concernant votre client ou ses commandes. Ils sont exclusivement liés à un client.

La variable add_tag permet d’ajouter des tags (séparés par une virgule).

La variable del_tag permet de supprimer des tags (séparés par une virgule).

 

 

Exemple :

  •  add_tag      :     « tag1,tag2,tag3 » 
  •  del_tag      :     « tag4 »

Javascript 3 - création de compte

 

Ce javascript permet d’intégrer automatiquement les visiteurs qui créent un compte sur votre site directement dans la CRM de SPREAD.

Le code suivant est à insérer sur la page de confirmation de création du compte, en plus du tag sur toutes les pages.

 

Code Block
languagejs
<script type="text/javascript">
var siteid = "????????????????" ; /*à remplacer par votre clé d’API*/
var sbactionSignup = 1; 
var spreadOrderEmail = "john@doe.com" ; 
var spreadOrderFirstname = "John" ; /* seulement si le nom et le prénom sont séparés*/
var spreadOrderName = "Doe" ; /* «John Doe» si pas séparés */ 
var spreadOrderOptin = 1 ; 
var ordertest = 0 ; 


/* Champs optionnels */
var spreadOrderBirthday = "1975-12-25"; 
var spreadOrderGender = "male"; /* ou «female» */
var spreadOrderAddress = "8, rue de la place";
var spreadOrderCp = "76000";
var spreadOrderCity = "Rouen";
var spreadOrderCountry = "FR"; /* pays au format ISO : FR, ES, IT, DE... */
var spreadOrderTel = "0235000000";
var spreadOrderMobile = "0690870089";
var spreadOrderFonction = "CEO";
var spreadOrderCompany = "My Company";

/* Champs personnalisables */
/* 7 et 8 correspondent aux id des champs personnalisables que vous trouvez dans votre backoffice, menu Paramétrage > Tracker */
var sbCustomFields = {custom_fields : {7 : "Professionnel", 8 : "Cosmétique"}}; 
/* Tags */
var add_tag = "tag1, tag2, tag3";
var del_tag = "tag4";

</script>
Info

Pour retrouvez les identifiants de vos champs personnalisables, rendez-vous dans le paramétrage du tracker.

 

 

Informations obligatoires

 

Les seules informations obligatoires sont :

  •  le «spreadOrderEmail» qui est l’adresse email du client
  •  le «siteid»
  •  le «sbactionSignup» qui permet de savoir qu’il s’agit d’une création de compte

 Détail des  variables

 

VariablesDescriptionTypesiteid

Clé API Publique Spread (Paramètrage > Tracker)

chaîne

 facultatif si «publicKeySb» est définie

spreadOrderEmail 

Adresse email du client 

chaîne

 obligatoire 

spreadOrderAmount

Montant de la commande 

num

point en séparateur de décimal 

spreadOrderFirstname

Prénom du client 

chaîne 

spreadOrderName

Nom du client.

 (Si le prénom n’est pas dissocié, ne pas mettre orderfirstname et mettre le nom ET le prénom dans ordername)

chaîne 

spreadIdOrder

Identifiant unique de commande 

chaîne, fortement conseillée

spreadOrderOptin

Le client accepte de recevoir votre newsletter 

boolean 1 ou 0 

spreadOrderState

Etat de la commande 

integer
10 : enregistrée 

 20 : payée 

 50 : expédiée 

 100 : reçue

0 : annulée 

ordertest 

à 1, le script affiche les valeurs chargées au lieu d’effectuer le tracking 

boolean

1 ou 0

sbOrderNum 

Pour passer un numéro de commande (public contrairement à l’idorder) 

varchar
VariablesDescriptionType
spreadOrderBirthdayDate d'anniversaire

date

("YYYY-MM-DD")

spreadOrderGenderSexe : female ou malechaîne
spreadOrderAddressAdressechaîne
spreadOrderCpCode Postalchaîne
spreadOrderCityVillechaîne
spreadOrderCountryPayschaîne
spreadOrderTelNuméro de téléphonechaîne
spreadOrderMobileNuméro de portablechaîne
spreadOrderFonction

Fonction occupée dans l'entreprise

(BtoB)

chaîne
spreadOrderCompany

Entreprise du client

(BtoB)

chaîne
add_tag

Possibilité de passer des informations liées au client

(Abonnement, etc...)

chaîne
del_tagPossibilité de supprimer un tag ajouté précédemmentchaîne

Intégration solutions e-commerce

 

Découvrez dans la documentation «solutions» l’intégration avec votre logiciel ecommerce. 

 

A télécharger ici : http://sb.am/public/Integration_traqueur_SB_solution.pdf 

 

Historique du document

 

2.3 - 28 mars 2014 : gestion des tags et ajout de champs optionnels : adresse, ville, code postal, téléphone, fonction, entreprise.

 

2.2 - 17 novembre 2013 : charset UTF-8 dans le javascript

 

2.1 - 23 juillet 2013 : séparation nom / prénom

 

2.0 - 6 juin 2013 : détails sur les widgets

 

1.9 - 27 mai 2013 : ajout de détails sur les variables et les javascript

 

1.8 - 27 janvier 2013 : ajout des variables anniversaire, sexe et pays

 

1.7 - 4 janvier 2013 : ajout du sbOrderNum 

 

1.6 - 27 novembre 2012 : remplacement de static.sb.am par static-sb.com dans le code de tracking

 

1.5 - 27 octobre 2012 : ajout des «custom fields» qui permettent d’insérer des infos de type text, num, date ou boolean dans la CRM

 

1.4 - 19 octobre 2012 : nouvelle version du javascript et nouveau code à insérer qui gère l’inscription à l’espace client d’un site e-commerce et des actions personnalisées

 

1.3 - 18 avril 2012 : nouvelle version du javascript à installer sur tout le site pour pouvoir activer les widgets

 

1.2.2 - 12 janvier 2012 : lien vers le document spécifique sur les solutions ecommerce

 

1.2.1 - 1 décembre 2011 : détails 42Stores

 

1.2 - 17 novembre 2011 : ajout du protocole HTTPS

Les paramètres n’ont pas changé, si votre site n’utilise pas de https sur votre page de conversion, vous n’avez pas besoin de mettre à jour.

 

1.1.1 - 14 octobre 2011 : correction des " autour de la clé d’API dans le javascript. Nouvelle version du plugin Prestashop

 

1.1 - 3 octobre 2011 : ajout des informations sur l’ensemble des plateformes et solutions ecommerce.

 

1.0 - version initiale

 

 

Besoin de plus d'aide?

Column
width30%
Align
alignleft

 

Pour toutes questions et informations supplémentaires, n'hésitez pas à contacter notre support par email à support@spreadfamily.com

Column
width5%

 

Column
width30%
Align
alignright

 

Le support technique est aussi disponible dans votre backoffice en haut à droite dans «AIDE»

 

Column
width5%

 

Column
width30%
Align
aligncenter
 Image Removed

Image Added Pour être informés de toutes les mises à jour concernant l’API de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2


Info
titleSommaire

Table of Contents
maxLevel2




Warning

Si vous utilisez un gestionnaire de tag type Google Tag Manager pour intégrer SPREAD, passez par cette documentation.

Fonctionnalités de l'intégration en JavaScript

Le JavaScript de SPREAD permet :

  •  d'afficher les widgets sur votre site web

  •  de remonter les créations de compte dans SPREAD

  •  de remonter les commandes dans SPREAD

Le JavaScript de SPREAD a été conçu pour ne pas ralentir le temps d’affichage de vos pages (fonctionnement asynchrone) et ainsi vous garantir un fonctionnement transparent.

Warning
titleAvertissement

L'intégration de SPREAD demandant du temps, pour utiliser SPREAD en attendant, nous vous recommandons d'importer votre CRM et de la mettre à jour toutes les semaines !

Voir les documentations sur l'import


Il n'est pas nécessaire d'attendre la fin de l'intégration pour communiquer auprès de vos contacts ou mettre en place des opérations marketing.

JAVASCRIPT 1 - Affichage des widgets

Ce JavaScript est à insérer sur toutes les pages du site, dans le footer juste avant la balise </body>.

Sa fonction principale est de permettre de piloter les widgets depuis le back office SPREAD.

Associé aux scripts de remontée de création de compte (JavaScript 2) et à la remontée des commandes (JavaScript 3), il permet également de faire remonter des informations dans la CRM SPREAD.

Cliquez ici pour accéder aux exemples de code et intégrez le code JAVASCRIPT entre les commentaires suivants :

Début : // JAVASCRIPT 1 - Affichage des widgets

Fin : // Fin JAVASCRIPT 1

Dans ce script, modifiez <PUBLIC_KEY> par votre clé d'API publique que vous trouverez dans votre back office (onglet Paramétrage > Tracker)


Note
titleAttention

N'intégrez pas directement le fichier sb-tracker.js sur votre site !

Si vous le faites, vous ne pourrez pas bénéficier des mises à jour que nous réalisons régulièrement.

Détail des variables

Variables

Description

Type

public_key

Clé API publique SPREAD (à trouver dans Paramètrage > Tracker)

chaîne

obligatoire

debug

True permet d'afficher les logs dans la console

boolean

true ou false

set_cookie

True permet d'attribuer le cookie aux clients

Important pour le parrainage et les widgets sur segment par exemple

boolean

true ou false

track_order_enabled

True permet aux remontées de commandes et de créations de compte de se faire dans le JavaScript et en GET

boolean

true ou false

La fonction loadSpreadTracker

Cette fonction doit être placée sur toutes les pages de votre site.

Elle est essentielle au bon fonctionnement de nos scripts et doit être placée après le script spconfig.

JAVASCRIPT 2 - Remontée des créations de compte

Ce JavaScript permet d’intégrer automatiquement les visiteurs dans la CRM de SPREAD lorsqu'ils créent un compte sur votre site.

Le code suivant est à insérer sur la page de confirmation de création du compte dans le footer,en plus du tag sur toutes les pages et avant la fonction loadSpreadTracker.

Note

L'optin est toujours récolté au nom d'optin, mais pour répondre au RGPD nous réattribuons cela dans un consentement dans SPREAD. Pour que cela soit fonctionnel, pensez à configurer "Paramètrage > Tracker > RGPD"


Cliquez ici pour accéder aux exemples de code et intégrez le code JAVASCRIPT entre les commentaires suivants :

Début : // JAVASCRIPT 2 - Remontée des créations de compte

Fin : // Fin JAVASCRIPT 2


Informations obligatoires

Pour remonter les nouveaux clients, seulement certaines données doivent impérativement être présentes dans le script. Il s'agit de :

  •  «email» l’email du client.
  •  «action : "signup" » permet de détecter qu'il s'agit d'une création de compte.


Détail des variables

VariablesDescriptionType

email

Adresse email du client 

chaîne

obligatoire

name

Nom du client.

(Si le prénom n’est pas dissocié, ne pas mettre firstname et mettre le nom ET le prénom dans name)

chaîne 

firstname

Prénom du client 

chaîne 

optinEtat de l'abonnement à la newsletter

boolean

1 ou 0 (ou -1)

countryPayschaîne
birthdayAnniversaire

date

yyyy-mm-dd

genderCivilité

chaîne

male ou female

addressAdresse (Numéro et rue)chaîne
cpCode postalchaîne
cityVillechaîne
telNuméro de téléphonechaîne
mobileNuméro de téléphone mobilechaîne
tel_optinLe numéro de téléphone est il disposé à recevoir des appels de votre part

boolean

1 ou 0

mobile_optinLe numéro de téléphone mobile est il disposé à recevoir des sms de votre part

boolean

1 ou 0

fonctionPoste dans l'entreprisechaîne
companyNom de l'entreprisechaîne
action

"signup"

Permet de détecter qu'il s'agit d'une création de compte dans le back office SPREAD

chaîne

obligatoire

add_tag

Indique un ou plusieurs tag dans la fiche du client

chaîne

del_tag

Supprime un ou plusieurs tag dans la fiche du client

chaîne 

custom_fields

Champs personnalisés

Multiple


JAVASCRIPT 3 - Remontée de commandes

Ce JavaScript permet de remonter automatiquement les commandes et les informations clients dans la CRM de SPREAD lorsqu'ils passent commande sur votre site.

Le code suivant est à insérer sur la page de confirmation de commande dans le footer, en plus du tag sur toutes les pages et avant la fonction loadSpreadTracker.

Note

L'optin est toujours récolté au nom d'optin, mais pour répondre au RGPD nous ré-attribuons cela dans un consentement dans SPREAD. Pour que cela soit fonctionnel, pensez à configurer "Paramètrage > Tracker > RGPD"


Cliquez ici pour accéder aux exemples de code et intégrez le code JAVASCRIPT entre les commentaires suivants :

Début : // JAVASCRIPT 3 - Remontée de commandes

Fin : // Fin JAVASCRIPT 3


Tip
titleAstuce de l'équipe

Si vous souhaitez faire remonter des champs qui sont propres à votre secteur d'activité, vous pouvez utiliser les champs personnalisés.


Informations obligatoires

Pour la remontée de commandes, seulement certaines données doivent impérativement être présentes dans le script. Il s'agit de :

  •  «email» l’email du client,
  • «idorder» la référence commande,
  • «amount» le montant,
  • «state» le statut de la commande,
  • «date» la date de la commande,
  •  «action : "order" » permet de détecter qu'il s'agit d'une commande vous pourrez alors vérifier votre remontée de commandes

Détail des variables

VariablesDescriptionType

email

Adresse email du client 

chaîne

obligatoire

amountMontant de la commande

numérique

obligatoire - Point en séparateur de décimale

idorderRéférence de la commande

chaîne

obligatoire

dateDate de la commande

date

obligatoire (yyyy-mm-dd hh:mm:ss UTC)

stateStatut de la commande

0 : annulée

10 : enregistrée

20 : payée

50 : envoyée

100 : reçue

obligatoire

name

Nom du client.

(Si le prénom n’est pas dissocié, ne pas mettre firstname et mettre le nom ET le prénom dans name)

chaîne 

firstname

Prénom du client 

chaîne 

optinEtat de l'abonnement à la newsletter

boolean

1 ou 0

countryPayschaîne
birthdayAnniversaire

date

yyyy-mm-dd

genderCivilité

chaîne

male ou female

addressAdresse (Numéro et rue)chaîne
cpCode postalchaîne
cityVillechaîne
telNuméro de téléphonechaîne
mobileNuméro de téléphone mobilechaîne
tel_optinLe numéro de téléphone est il disposé à recevoir des appels de votre part

boolean

1 ou 0

mobile_optinLe numéro de téléphone mobile est il disposé à recevoir des sms de votre part

boolean

1 ou 0

fonctionPoste dans l'entreprisechaîne
companyNom de l'entreprisechaîne
action

"order"

Permet de détecter qu'il s'agit d'une commande dans le BackOffice SPREAD, vous permet ainsi de les retrouver dans "Paramétrage > Tracker > Vérifier la remontée de commandes"

chaîne

obligatoire

add_tag

Indique un ou plusieurs tag dans la fiche du client

chaîne

del_tag

Supprime un ou plusieurs tag dans la fiche du client

chaîne 

add_order_tagIndique un ou plusieurs tag sur les commandeschaîne
del_order_tagSupprime un ou plusieurs tag sur les commandeschaîne

custom_fields

Champs personnalisés

Multiple

Vous pouvez également ajouter davantage de détails à vos commandes avec les attributs produits


Gestion de l'idorder

La valeur «idorder» est l’identifiant unique de la commande sur la boutique.

La première fois que cet identifiant est utilisé, la commande est enregistrée dans la CRM. Si l’identifiant de commande est présenté une deuxième fois, les données sont mises à jour.

Cet identifiant est particulièrement utile pour changer l’état de la commande (l’annuler ou la mettre à expédier).


Gestion de l’état de la commande (state)

Grâce à l’«idorder» vous allez pouvoir faire évoluer l’état de la commande au fur et à mesure avec la variable state :

  • 10     :    Enregistré
  • 20     :    Payé
  • 50     :    Expédié
  • 100   :    Reçu
  • 0       :    Annulé



Tip
titleAstuce de l'équipe

L'intégration de SPREAD demandant du temps, pour utiliser SPREAD en attendant, nous vous recommandons d'importer votre CRM et de la mettre à jour toutes les semaines !

Voir les documentations sur l'import


Il n'est pas nécessaire d'attendre la fin de l'intégration pour communiquer auprès de vos contacts ou mettre en place des opérations marketing.


Note
titleRemarque

Une fois l'intégration de SPREAD terminée, vous devez réaliser un import de l'historique de vos commandes !

Cliquez ici pour consulter la documentation sur l'import de fichier CSV