API revolumail V0.3 beta

Couleurs des paramètres :

• Obligatoire
• Optionnel
• Pas encore implémenté

La sandbox ('bac à sable') vous permets de tester l'API d'envoi d'email (il faut posséder un compte)
et l'API de récupération des statistiques

Méthode : POST

vous pouvez trouver un exemple d'envoi d'email en utilisant l'API en Python Ici, ou en Php Ici.

Paramètres de la requête :

Si le format est le json, alors les données envoyées doivent *obligatoirement* contenir un champ "email" pour les emails, ou "tel" (pour fax et sms)

exemple pour un envoi d'emails en JSON:

    [ 
        { "email" : "machin@gmail.com", "nom" : "machin" , "age" : 42 },
        { "email" : "bidule@free.fr", "nom" : "bidule" , "prenom" : "truc" }
    ]

exemple pour un envoi de faxes :

    [
        { "tel" : "0145454545", "nom" : "machin" , "age" : 42 },
        { "tel" : "0145454545", "nom" : "bidule" , "prenom" : "truc" }
    ]

exemple pour un envoi d'emails en CSV:

    email,nom,age
    machin@gmail.com,machin,42
    bidule@free.fr,bidule,25
    

La première ligne définit les noms des paramètres.

2.2) Le template

Les données que vous avez envoyées dans le champ 'datas' sont accessibles en insérant {{ data.* }} dans votre template. Par exemple, vous pouvez créer le template suivant pour votre mailing :

    Bonjour {{data.nom_complet}}, <br><br>
    
    Nous vous proposons une offre exceptionnelle, valable jusqu'au {{data.fin_offre}} <br><br>
    
    <a href="http://www.perdu.com">Cliquez ici pour en bénéficier de suite !</a><br> 

Tous les filtres intégrés à Django peuvent être utilisés dans vos templates, par exemple {{ data.nom_complet|capfirst }}, qui mettra la première lettre du nom en majuscule.

Si un champ n'existe pas dans les datas envoyées, son contenu n'apparaitra pas dans le mail/fax/sms final.

2.3) Ajout de fichier attaché

Cette fonctionalité est évidement uniquement accessible lorsque le type d'envoi est l'email ou fax.
Pour ajouter un ou plusieurs fichier(s) à attacher à l'email lors de l'envoi, il faut modifier le formatage des paramètres,
passer d'un mode d'envoi (ou enctype) 'application/x-www-form-urlencoded' (comme un formulaire en POST normal)
à un mode d'envoi 'multipart/form-data' (comme un formulaire en POST avec un input type=file).

exemple de requête contenant un fichier à joindre à la campagne d'email :

        ...
        
        Content-Type: multipart/related; boundary="===============1931184483"
        
        ...
        
        --===============1931184483==
        Content-Type: application/octet-stream
        MIME-Version: 1.0
        Content-Transfer-Encoding: base64
        Content-Disposition: form-data; filename="mon_fichier.ext"

        bW9uIGN2IGJsYWJsYQ==
        --===============1931184483==--
    

Notez que les librairies les plus souvent utilisées pour forger directement des requêtes HTTP (PEAR/HTTP_request ou cURL en php, urllib2 en python) permettent de faire ceci assez simplement.
Quelques liens pour expliquer le fonctionement :
La spécification HTML du content-type "multipart/form-data" (en anglais)
Une classe en python pour poster en "multipart/form-data"
Un exemple en php (et cURL) d'envoi de mailing avec un fichier attaché

3) Récupération des statistiques

http://www.revolumail.com/stats

3.1) Liste des campagnes de l'utilisateur

cmd=list

    [
         "nom_campagne1"
        ,"mailing-2568"
        ,"mailing-6587"
    ]

3.2) Statistiques globales d'une campagne précise

cmd=global&mailing=NomDeLaCampagne

Ou "NomDeLaCampagne" dois être remplacé par la valeur du nom de la campagne telle que récupérée par la requête cmd=list

NB : ce nom peut diverger de celui choisi lors de l'envoi du mailing, car il est transformé pour être unique et valide dans une URL. Vous devez donc veiller à utiliser le nom fourni par la commande cmd=list

Données renvoyées :

3.3) Détails d'une campagne précise

cmd=details&mailing=NomDeLaCampagne

Ou "NomDeLaCampagne" dois être remplacé par la valeur du nom de la campagne telle que récupérée par la requête cmd=list

NB : ce nom peut diverger de celui choisi lors de l'envoi du mailing, car il est transformé pour être unique et valide dans une URL. Vous devez donc veiller à utiliser le nom fourni par la commande cmd=list

 

Code	Description
0	Le Message est prêt à être envoyé
10	Le Message sera envoyé très prochainement
20	Le Message a été envoyé avec succès
30	Le Message a été ouvert par le destinataire (email seulement)
31	Le destinataire s'est desabonné (email seulement)
40	Le Message n'a pas pu être envoyé au destinataire
41	Le Message n'a pas pu être envoyé au destinataire, les données ne contenant pas d'adresse valide (ou tel, suivant le type de la campagne)
42	Le Message n'a pas pu être envoyé au destinataire, une erreur c'est produite pendant la génération du message
43	Le Message n'a pas pu être envoyé au destinataire, impossible de joindre le serveur d'envoi
44	Le Message n'a pas pu être envoyé au destinataire, le serveur d'envoi a refusé la connection
45	Le Message n'a pas été envoyé au destinataire, car il s'est désabonné
46	Le Message n'a pas été envoyé au destinataire, car un message lui à déjà été envoyé lors de ce mailing (supréssion des doublons)
50	Le Message a été envoyé mais le destinataire ne l'a pas reçu
51	Le Message a été envoyé mais le destinataire ne l'a pas reçu, car son adresse (ou son tel) est inconnue
52	Le Message a été envoyé mais le destinataire ne l'a pas reçu, car son adresse (ou son tel) est incorrecte
53	Le Message a été envoyé mais le destinataire ne l'a pas reçu, car le serveur a considéré le message comme du spam