WS Subscribe

Le webservice permettant l''inscription et la désinscription des abonnés

Description

Ce Web Service permet :

• La vérification de l'état d'un email (inscrit ou non)

• L'inscription d'un email

• La désinscription d'un email

• La récupération de la réponse à une question du profil pour un email

• La modification de la réponse à une question du profil pour un email

Comme on peut le remarquer, celui-ci agit toujours de manière synchrone avec un seul abonné/email. Il est ainsi adapté à un besoin de synchronisation en temps réel des inscriptions/désinscriptions/mises à jour, mais en aucun cas à un besoin d'imports ou de crons.

Méthodes

Outres les méthodes des Web Services de base (connexion et options), celui-ci offre plus spécifiquement ces méthodes :

• isSubscribed (xs:string email) Permet de récupérer l'état de l'adresse email (true=>abonnée, false=>non-abonnée)

• subscribe (xs:string email) Permet d'inscrire l'adresse email spécifiée

• unsubscribe (xs:string email) Permet de désinscrire l'abonné correspondant à l'adresse email spécifiée

• getProfile (xs:string email, xs:int numQuestion) Permet de récupérer la réponse de l'abonné 'email' à la question ayant pour id : 'numQuestion'. Cet id doit vous être fourni par notre support technique et dépend de la liste de diffusion sélectionnée.

• setProfile (xs:string email, xs:int numQuestion, xs:string reponse) Permet de spécifier 'reponse' comme réponse de l'abonné 'email' à la question ayant pour id : 'numQuestion'. Cet id doit vous être fourni par notre support technique et dépend de la liste de diffusion sélectionnée.

Options :

Les options suivantes peuvent être configurées à tout moment par la méthode décrit sur la page générique des Web Services :

• mail_subscribe_format Format d'inscription aux newsletters. Peut être :

  • (LS_FORMAT_TEXT) : Inscrit la personne en Texte uniquement

  • (LS_FORMAT_HTML) : Inscrit la personne en Html uniquement

  • (LS_FORMAT_BOTH) :Inscrit la personne en Texte+Html [Option par défaut]

• mail_subscribe_etat Etat lors de l'inscription aux newsletters. Peut être :

  • (ABO_ETAT_INACTIF) : Inscription à confirmer (attention, un email de confirmation est alors envoyé selon le paramétrage défini pour cette liste)

  • (ABO_ETAT_ACTIF) : Inscription déjà confirmée [Option par défaut]

  • (ABO_ETAT_TESTMAIL) : Inscription dans les adresses email de test

• mail_subscribe_from Défini pour les statistiques, l'origine de l'inscription. Peut être :

  • (ABO_INSCRIT_IMPORT) : Abonné provenant d'un import de l'administrateur

  • (ABO_INSCRIT_FORM) : Abonné s'étant lui-même inscrit sur un formulaire [Option par défaut]

  • (ABO_INSCRIT_ADMIN) : Abonné ajouté par l'administrateur.

• mail_unsubscribe_type Défini le type de désinscription d'un abonné. Peut être :

  • (ABO_DESINSCRIT_DESINSCRIT) : Abonné désabonné par sa propre volonté (attention, il sera alors impossible de le rajouter à la liste dans l'interface de mailing-plus) [Option par défaut]

  • (ABO_DESINSCRIT_SUPPRIME) : Abonné supprimé par l'administrateur.