Documentation de l'Api

Introduction

L'API de SG-Autorépondeur vous permet de récupérer des informations provenant de votre compte (listes, formulaires, emails, etc.) mais aussi de créer un certain nombre d'éléments à distance (inscription d'un abonné, création d'une liste, d'un email, etc.)

La colonne à droite vous affiche un exemple de code en PHP pour utiliser l'API de SG-Autorépondeur.
Cliquez ici pour télécharger les fichiers d'exemple.

Sommaire

//Le code PHP indiqué ici est donné à titre indicatif

Authentication

Pour vous connecter à l'API de SG-Autorépondeur, vous avez besoin de 2 éléments :

  • Votre numéro de membre
  • Votre code d'activation
                                
                                    include(__DIR__.'/sgapi.php');

                                    $membreid = [YOUR_ID];
                                    $codeactivation = '[YOUR_CODE]';

                                    //démarrage de l'api
                                    $sgApi = new SGApi($membreid, $codeactivation);
                                
                                

Abonnés

Vous pouvez récupérer les abonnés d'une liste en particulier, récupérer les informations d'un abonné, inscrire ou encore désinscrire un abonné.

Récupérer des abonnés

idabonne
integer Identifiant de l'abonné
nom
string Nom de l'abonné
prenom
string Prénom de l'abonné
email
string Adresse email de l'abonné
dateinscription
string Date d'inscription de l'abonné (au format annee-mois-jour)
listeid
integer Numéro de liste dans lequel est présent cet abonné
actif
integer Etat de l'abonné :
0 : Non activé
1 : actif
2 : Résilié
5 : Invalide
//on recherche les abonnés actifs de la liste 1234, inscrits le
                                //20 Octobre 2015
                                $sgApi->set('listeid', 1234)
                                ->set('dateinscription', '2015-10-23')
                                ->set('actif', 1);

                                //appel
                                try {
                                $call = $sgApi->call('abonnes');
                                } catch (Exception $e) {
                                echo $e->getMessage();
                                exit();
                                }

                                //Réponse
                                [
                                [
                                'idabonne' => 75869,
                                'nom' => 'Dupont',
                                'prenom' => 'Jean',
                                'email' => 'jean.dupont@email.com',
                                'dateinscription' => '2015-10-23',
                                'listeid' => 1234,
                                'actif' => 1,
                                ],
                                [
                                'idabonne' => 76532,
                                'nom' => 'Dupond',
                                'prenom' => 'Robert',
                                'email' => 'robert.dupond@email.com',
                                'dateinscription' => '2014-09-12',
                                'listeid' => 5678,
                                'actif' => 1,
                                ]
                                ]
                            
                        

Listes

Vous pouvez récupérer les informations d'une liste ou créer une liste.

Récupérer les listes

listeid
integer Identifiant de la liste
//appel
                                try {
                                $call = $sgApi->call('listes');
                                } catch (Exception $e) {
                                echo $e->getMessage();
                                exit();
                                }
                        
                                //Réponse
                                [valid] => 1
                                [data] => Array (
                                    [0] => Array (
                                        [id] => {vos_infos}
                                        [membreid] => {vos_infos}
                                        [nom] => {vos_infos}
                                        [description] => {vos_infos}
                                        [siteweb] => {vos_infos}
                                        [emailexpediteur] => {vos_infos}
                                        [nomexpediteur] => {vos_infos}
                                        [adresseexpediteur] => {vos_infos}
                                        [mobile_expediteur] => {vos_infos}
                                        [reponseemail] => {vos_infos}
                                        [signature] => {vos_infos}
                                        [optin] => {vos_infos}
                                        [mailinscription] => {vos_infos}
                                        [mailconfirmation] => {vos_infos}
                                        [maildesinscription] => {vos_infos}
                                        [mailsommeil] => {vos_infos}
                                        [sujetinscription] => {vos_infos}
                                        [sujetconfirmation] => {vos_infos}
                                        [sujetdesinscription] => {vos_infos}
                                        [sujetsommeil] => {vos_infos}
                                        [lieninscription] => {vos_infos}
                                        [lieninscriptiondouble] => {vos_infos}
                                        [lienconfirmation] => {vos_infos}
                                        [liendesinscription] => {vos_infos}
                                        [formhtml] => {vos_infos}
                                        [formhtmlhidden] => {vos_infos}
                                        [formhtmlperso] => {vos_infos}
                                        [champsobligatoires] => {vos_infos}
                                        [form_image_fond] => {vos_infos}
                                        [langue] => {vos_infos}
                                        [liensiteentier] => {vos_infos}
                                        [codepartage] => {vos_infos}
                                        [formhtmldesign] => {vos_infos}
                                        [notification] => {vos_infos}
                                        [notification_desinscription] => {vos_infos}
                                        [titreaccroche] => {vos_infos}
                                        [texteaccroche] => {vos_infos}
                                        [nomdedomaine] => {vos_infos}
                                        [lienretoursite] => {vos_infos}
                                        [lienimageerreur] => {vos_infos}
                                        [texteconfirmationoptinnon] => {vos_infos}
                                        [dateexport] => {vos_infos}
                                        [forcerdateinscription] => {vos_infos}
                                        [etape1_minutes] => {vos_infos}
                                        [etape2_minutes] => {vos_infos}
                                        [mois_reactivation] => {vos_infos}
                                        [dkim_valid] => {vos_infos}
                                        [spf_valid] => {vos_infos}
                                        [nbr_envoi] => {vos_infos}
                                        [nbr_ouvre] => {vos_infos}
                                        [nbr_clic] => {vos_infos}
                                        [parent] => {vos_infos}
                                        [jour_desactivation] => {vos_infos}
                                        [decalage_retour] => {vos_infos}
                                        [fin_sequence] => {vos_infos}
                                        [fin_sequence_action] => {vos_infos}
                                        [sujetupsell] => {vos_infos}
                                        [msgupsell] => {vos_infos}
                                        [minutesupsell] => {vos_infos}
                                        ),
                                    [1] => Array ( ... )