API Tracking et soumission de formulaires Marketing
Grâce à l'API Tracking, vous pouvez soumettre des informations ou des formulaires koban marketing sans avoir recours aux insertions html koban.
Cette méthode vous permet par exemple d'associer des appels à Koban Marketing dans le cadre d'un formulaire web complexe ou coté serveur, associé à du code métier (par exemple au sein d'une application web).
D'autre part, la bibliothèque javascript de Tracking vous permet également d'utiliser les capacités du tracking Koban et d'interagir directement dans votre page Web. Consultez les méthodes javascript ici.
Soumission de formulaires
La soumission de formulaire permet d'enregistrer le SUBMIT sur un formulaire Koban via code javascript ou appel REST à l'API Tracking
Via Javascript
// On initialise l'utilitaire Koban
var kbn = new kbnutils({ sandbox: false, apikey: "XXXXXXXXXXXXXXXXXX" });
// On récupère les informations du client
var infos = kbn.clientinfos();
// On prépare les informations à envoyer
var forminfo = {
fid: '561a62a70dc3610e7458xxxx', // Identifiant du formulaire
lpid: '587106e80dc37008ac1xxxxx', // Identifiant de la landing page
unid: 'SECXXXXXXXXXX', // Clé de sécurité (Demander cette clé au support utilisateur)
infos: { // informations à transmettre
contact_name: 'ACMETEST', // Nom de la personne
Tag5502afe50dc3610e8c5fd66f: '5502afe50dc3610e8c5fd66c', // tag associé (Taille de structure)
Spe57cfe7b40dc3610ed8db0bf5: '38' // Champ supplémentaire (Age)
}
};
// Lancement de la soumission
kbn.submitform(forminfo, function (res, data) {
});
Coté serveur
L'appel à la méthode peut se faire via requête POST HTTP de la façon suivante :
POST http://devtrack.itsonlyleads.com/Form/sbm?id=[IDFORMULAIRE]&cid=[IDKOBANCLIENT]&zid=[CLESECURITE]&_cnl=&_scl=&_lp=[IDLANDINGPAGE]&utm_campaign=&utm_source=&utm_medium=&utm_content=&utm_term= HTTP/1.1
Host: devtrack.itsonlyleads.com
Connection: keep-alive
Content-Length: 105
Accept: */*
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
contact_name=ACMETEST&Tag5502afe50dc3610e8c5fd66f=5502afe50dc3610e8c5fd66c&Spe57cfe7b40dc3610ed8db0bf5=38
Vous pouvez transmettre en paramètre les UTM désirés. De la même manière, vous pouvez en corps de formulaire transmettre les données associées (ici le prénom et la valeur d'un champ spécifique).
la valeur IDKOBANCLIENT peut être récupérée coté client grâce à la méthode javascript clientinfos() de l'objet kbnutils (cf code javascript ci-dessus).
Soumission d'informations
La soumission d'informations permet d'enregistrer des informations sur une piste via code javascript ou appel REST à l'API Tracking
Via Javascript
// On initialise l'utilitaire Koban
var kbn = new kbnutils({ sandbox: false, apikey: "XXXXXXXXXXXXXXXXXX" });
// On récupère les informations du client
var infos = kbn.clientinfos();
// On prépare les informations à envoyer
var forminfo = {
unid: '5502a6d30dc361046cba4b1d', // Clé de sécurité
infos: { // informations à transmettre
Spe57cfe7b40dc3610ed8db0bf5: '41', // Champ supplémentaire (Age)
FirstName: 'Paul'
}
};
// Lancement de la soumission
kbn.submitinfos(forminfo, function (res, data) {
});
Coté serveur
L'appel à la méthode peut se faire via requête POST HTTP de la façon suivante :
POST http://devtrack.itsonlyleads.com/Form/svi?cid=[IDKOBANCLIENT]&zid=[CLESECURITE]&_cnl=&_scl=&utm_campaign=&utm_source=&utm_medium=&utm_content=&utm_term= HTTP/1.1
Host: devtrack.itsonlyleads.com
Connection: keep-alive
Content-Length: 53
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Spe57cfe7b40dc3610ed8db0bf5=41&contact_firstname=Paul
Vous pouvez transmettre en paramètre les UTM désirés. De la même manière, vous pouvez en corps de formulaire transmettre les données associées (ici le prénom et la valeur d'un champ spécifique).
la valeur IDKOBANCLIENT peut être récupérée coté client grâce à la méthode javascript clientinfos() de l'objet kbnutils (cf code javascript ci-dessus).
Cette méthode retourne un objet comportant la propriété ckt. Cette propriété est à transmettre en lieu et place de IDKOBANCLIENT.
Méthodes Javascript de Koban Tracking
Le code de tracking peut prendre plusieurs arguments complémentaires. Vous pouvez via ce biais personnaliser le comportement du tracking.
Mise en place d'une fonction callback après la prise en compte du tracking
Vous pouvez déclarer une fonction javascript qui sera executée après la prise en compte du tracking en transmettant comme arguments les valeurs de contexte
(function (i, s, o, g, r, a, m) {
i['KobanObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})
(window, document, 'script', 'XXXXXXX/libapi/kobantracker.js', 'kb');
kb('reg', 'XXXXXXXXXXXXXX'); // Il s'agit de la déclaration classique du tracker Koban
kb('callback', 'result'); // On paramètre une fonction javascript CallBack
function result(res){
console.log(res);
// La fonction sera executée après le tracking. res aura comme valeur :
// { s: true, l: 'XXXXXX', ifos: [{ Guid: 'XXXX', Label: 'Tag 1' }, { Guid: 'XXXX', Label: 'Tag 2' }] }
}
Le contexte renvoyé est un objet javascript comportant les propriétés suivantes :
- s : Succès ou échec de l'appel au tracking
- l : Guid du lead généré. Cette chaine est vide si la page trackée n'est pas déclarée dans Koban.
- ifos : Objet contexte. Il est composé des propriétés suivantes :
- Score : Le score actuel de la piste
- Tags : Il s'agit de la liste des tags de la piste. Chaque tag a comme propriété Guid (Guid du tag) et Label (libellé du tag)