API CyberMailing

L'API de CyberMailing permet de réaliser des inscriptions et des désinscriptions d'abonnés de serveur à serveur, c'est à dire sans nécessiter la présence de l'internaute.

Une librairie client PHP est disponible pour accélérer vos développements et vos intégrations n'hésitez pas à l'utiliser.

    Authentification de l'utlisateur:

Elle est réalisée par la présence du champs CyberKey qui contient votre cléf privée. Consultez Mon compte >> Profil pour obtenir votre clef.

    Inscriptions et désinscriptions:

Point d'accès: http://api.cybermailing.com/talk.php

Vous devez transmettre le champs function avec la valeur subscribe pour une inscription et avec la valeur unsubscribe pour une désinscription.

    Identification de l'abonné:

Le couple de champs Email & Liste ou sont alternative tracking_id est requis. Les champs Ip contenant l'adresse IP du visiteur, et Url contenant l'url de la page ayant servi à la collecte des informations sont les bienvenus pour justifier éventuellement de la légitimité de l'inscription.

Exemple d'inscripition

$aInfo = array(
'CyberKey' => 'CSgDSPMHUD4WSKT97SMDITSUGND', // requis
'function' => 'subscribe', // requis
'Email' => [email protected]', // requis ou tracking_id
'Liste' => 123456, // requis ou tracking_id
'Ip' => $_SERVER['REMOTE_ADDR'], // bienvenu
'Url' => $_SERVER['HTTP_HOST'].'/'.$_SERVER['PHP_SELF'], // bienvenu
'Name'=>'avrael', // optionel
'Profession'=>'bandit', // champs personalisé - optionel
'Preference'=>'gateaux' // champs personalisé - optionel
);
 
$ch = curl_init('http://api.cybermailing.com/talk.php');
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch,CURLOPT_RETURNTRANSFER,TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $aInfo);
curl_exec($ch);
curl_close($ch);

Méthode alternative pour l'identification de l'abonné:

Email & Liste peuvent être remplacés par un seul champs: tracking_id

Vous pourrez obtenir la valeur de ce champs quand un abonné clique sur un lien de vos emails pour se rendre sur votre site, ou encore lorsqu'il est redirigé sur votre site lors du processus d'inscription et que vous avez laissé coché la case transmettre les informations de l'abonné dans l'url.

La page sur laquelle pointe le lien pourra récupérer la valeur de traking_id via $_GET['clt'].

La valeur du champs sera décripté par CyberMailing comme l'équivalent de l'adresse email et du no de liste, lui permettant de connaitre l'abonné auquel il correspond. Ce champs est donc un moyen commode de compléter des informations sur un abonné cyberMailing pendant qu'il navigue sur votre site.

Vous pouvez en stocker la valeur dans un cookie ou dans une session, afin de le récupérer sur n'importe quelle page pour le communiquer à cybermailing avec des des valeurs de champs personnalisés spécifiques lorsque telle ou telle action est réalisée sur votre site.

Exemple:

$aInfo = array(
'CyberKey' => 'CSgDSPMHUD4WSKT97SMDITSUGND', // requis
'function' => 'subscribe', // requis
'tracking_id' => $_SESSION['tracking_id'], // requis ou tracking_id
'Last_download'=>'recette_cuisine' // champs personalisé - optionel
);
 
$ch = curl_init('http://api.cybermailing.com/talk.php');
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch,CURLOPT_RETURNTRANSFER,TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $aInfo);
curl_exec($ch);
curl_close($ch);

    Copie ou déplacement dans une liste:

Pour placer un abonné dans une nouvelle liste, vous pouvez simplement l'inscrire, mais pour conserver les valeurs de tous ses champs personalisés, il est pls pratique d'utiliser la champs réservé copy2liste qui indiquera à cybermailing de récupérer toutes les valeurs des champs personnalisés de la liste d'origine et de les transmettre à la liste de destination.

Exemple copie de la liste no 123456 vers la liste no 654321

$aInfo = array(
'CyberKey' => 'CSgDSPMHUD4WSKT97SMDITSUGND', // requis
'function' => 'subscribe', // requis
'tracking_id' => $_SESSION['tracking_id'], // requis ou tracking_id
'copytoliste' => 654321,
'Last_download'=>'recette_cuisine' // champs personalisé - optionel
);
 
$ch = curl_init('http://api.cybermailing.com/talk.php');
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch,CURLOPT_RETURNTRANSFER,TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, $aInfo);
curl_exec($ch);
curl_close($ch);