Piste

Les pistes peuvent être manipulés à travers l'objet ncLead dans l'API.

L'objet ncLead

La piste récupérée ou à insérer via l'API est un objet comprenant les méthodes suivantes :
Company : Le nom de l'entreprise
EMail : L'Email du contact Obligatoire (ou Name)
FirstName : Le prénom du contact
Comments : Un commentaire sur la piste
Name : Le nom du contact Obligatoire (ou EMail)
Phone : Le téléphone fixe
Mobile : Le téléphone mobile
Statut : Le statut de la piste
IsNewsletter : Spécifie si la piste autorise la réception d'emails
Origin : L'origine de la piste. A renseigner comme suit : { Code : 'XXXX' }. Le code doit être défini dans la liste Origine au niveau de l'application Koban
Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification.

Méthodes disponibles

Exemple : Comment intégrer les contacts d'un site internet ?

L'exemple ci-dessous permet à partir d'un formulaire disposant des zones input d'identifiant company, email, name, phone de créer une piste au niveau de Koban CRM. Il utilise la bibliothèque javascript Koban


// Création de l'objet Koban
var _k = new koban({ sandbox: false, userlogin: "XXXXXX", apikey: "VOTRE_CLE" });
var _orig = "WEB";

// Création du lead à partir des données du formulaire et avec l'origine de code WEB.
var ld = {
Company: $("#company").val(),
EMail: $("#email").val(),
Name: $("#name").val(),
Comments: "Nouveau contact via le site internet",
Phone: $("#phone").val(),
Mobile: "",
Origin: { Code: _orig }
};

// Appel de Koban pour ajouter le lead
_k.addlead(ld, function (result) {
});

Exemple de requête Raw HTTP de création d'une piste

POST https://app-koban.com/api/v1/ncLead HTTP/1.1 Host: app-koban.com Connection: keep-alive X-ncApi: XXXXXXXXXXXX X-ncUser: XXXXXXXXXXX Content-Length: 108 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 Accept-Encoding: gzip, deflate, sdch Accept-Language: fr,fr-FR;q=0.8,en;q=0.6,en-US;q=0.4 Company=TEST&EMail=test%40test.fr&Name=TEST&Comments=Demande+de+d%C3%A9mo&Phone=15&Mobile=&IsNewsletter=true
Revenir à la liste des méthodes