API (Application Programming Interface)
Interface de programmation
L'API est accessible par web-service (SOAP et http-request). Nous fournissons également des bibliothèques de fonctions qui gèrent pour vous l'aspect communication et permettent à vos développeurs d'être immédiatement opérationnels.
Toutes les fonctionnalités proposées par Emailing Director sont accessibles par notre API.
Vous pouvez ainsi utiliser toute la puissance d'Emailing Director au sein même de vos applications.
Vous pouvez par exemple générer automatiquement un nouveau message depuis votre site, ou envoyer un email transactionnel depuis votre CRM.
Toutes les fonctionnalités proposées par Emailing Director sont accessibles par notre API.
Vous pouvez ainsi utiliser toute la puissance d'Emailing Director au sein même de vos applications.
Vous pouvez par exemple générer automatiquement un nouveau message depuis votre site, ou envoyer un email transactionnel depuis votre CRM.
L'exemple ci-dessous met en oeuvre la création et l'envoi d'une campagne.
Une fois connecté à la plateforme, il suffit de seulement trois instructions pour créer un message et l'envoyer avec une campagne.
Pour cela il est nécessaire de définir les attributs suivants :
Une fois connecté à la plateforme, il suffit de seulement trois instructions pour créer un message et l'envoyer avec une campagne.
Exemple 1 : Création d'une campagne depuis votre CRM ou votre site web
On commence par inclure la bibliothèque de fonctions.// On utilise le stub Php Axiway disponible à l'adresse // http://api.axiway.com/AxiwaySoapStub.phps require_once dirname(__FILE__).'/AxiwaySoapStub.php';La connexion à la plateforme Emailing director se fait par l'acquisiton d'un jeton d'authentification qui devra être spécifié à chaque appel d'une fonction de l'API.
// Acquisition d'un jeton d'authentification $token = AxiwayCampaign::authenticate($login,$password);A présent nous pouvons passer à la création et à l'enregistrement de votre message
Pour cela il est nécessaire de définir les attributs suivants :
- nom du message
- nom et adresse de l'expéditeur
- objet du message
- contenu html
- contenu texte
$idMessage = AxiwayMessage::createMessage( $token, // Jeton d'authentification 'Message promo 2011', // Nom du message 'Marie', // Nom de l'expediteur 'marie@monsite.com', // Adresse email de l'expediteur 'Promo spéciale pour 2011', // Objet du message '<html>...</html>', // Message en HTML '... Partie texte ...' // Message en Texte pur );Puis, à l'aide de ce message, on créé une campagne
$idCampaign = AxiwayCampaign::createCampaignToSubscription( $token, // jeton d'authentification 'Campagne promo 2011', // Nom de campagne 'cp2011', // Nom court de campagne $idMessage, // Le message qu'on vient de créer 'test@monsite.com', // Liste d'adresses de test 1, // Abonnement cible true // Bon à tirer );Notre campagne est à présent enregistrée, il ne nous reste plus qu'à la faire démarrer pour commencer les envois.
// Démarrage immédiat de la campagne AxiwayCampaign::campaignStartNow( $token, $idCampaign );
L'exemple ci-dessous concerne l'envoi d'un email transactionnel.
Une fois connecté, deux étapes sont suffisantes pour tirer pleinement profit de ce système.
Vous pourrez alors envoyer au fil de l'eau, mail par mail, toutes vos confirmations de commande, factures, alertes en bénéficiant de toutes les fonctionnalités d'Emailing Director.
Nous préparons donc la strucutre qui va contenir les données dynamiques du mail (le nom, prénom, numéro de commande et le prix total) :
Pour cela, il nous suffit de faire appel à la fonction campaignAddRecipient avec les données préparées ci-dessus :
Une fois connecté, deux étapes sont suffisantes pour tirer pleinement profit de ce système.
Vous pourrez alors envoyer au fil de l'eau, mail par mail, toutes vos confirmations de commande, factures, alertes en bénéficiant de toutes les fonctionnalités d'Emailing Director.
Exemple 2 : Email transactionnel
On commence par inclure la bibliothèque de fonctions.// On utilise le stub Php Axiway disponible à l'adresse // http://api.axiway.com/AxiwaySoapStub.phps require_once dirname(__FILE__).'/AxiwaySoapStub.php';La connexion à la plateforme Emailing director se fait par l'acquisiton d'un jeton d'authentification qui devra être spécifié à chaque appel à une fonction de l'API.
// Acquisition d'un jeton d'authentification $token = AxiwayCampaign::authenticate($login,$password);Nous souhaitons envoyer une confirmation de commande à John Smith. La commande porte le numéro 14237 et le prix total est de 38,65€
Nous préparons donc la strucutre qui va contenir les données dynamiques du mail (le nom, prénom, numéro de commande et le prix total) :
// préparation du contenu dynamique $replaceList = array ( array( 'field' => 'prenom' , 'value' => 'John' ), array( 'field' => 'nom' , 'value' => 'Smith' ), array( 'field' => 'commande' , 'value' => '14237' ), array( 'field' => 'prixTotal' , 'value' => '38.65' ), );Il ne nous reste plus qu'à envoyer l'email transactionnel de confirmation de commande.
Pour cela, il nous suffit de faire appel à la fonction campaignAddRecipient avec les données préparées ci-dessus :
// Ajout d'un nouvel envoi AxiwayCampaign::campaignAddRecipient( $token, // Jeton d'authentification 3, // Identifiant de la campagne "john@example.com", // Email du destinataire $replaceList // Contenu dynamique );
Emailing Director propose des solutions d'intégration de vos données très facile comme la connexion directe,
ou la synchronisation de table.
Nous proposons également le double-posting grâce à l'API. Dans ce cas, si une personne s'inscrit sur votre site, vous devez enregistrer ses informations dans votre base de données et les envoyer (les double-poster) vers Emailing Director pour qu'elles soient disponibles sur notre plateforme.
Nous préparons donc la structure de données qui va permettre d'enregistrer ces informations dans Emailing Director. Pour chaque colonne de la table de destination, nous indiquons la donnée qui doit y être enregistrée.
Nous proposons également le double-posting grâce à l'API. Dans ce cas, si une personne s'inscrit sur votre site, vous devez enregistrer ses informations dans votre base de données et les envoyer (les double-poster) vers Emailing Director pour qu'elles soient disponibles sur notre plateforme.
Exemple 3 : Double-posting
On commence par inclure la bibliothèque de fonctions.// On utilise le stub Php Axiway disponible à l'adresse // http://api.axiway.com/AxiwaySoapStub.phps require_once dirname(__FILE__).'/AxiwaySoapStub.php';La connexion à la plateforme Emailing director se fait par l'acquisiton d'un jeton d'authentification qui devra être spécifié à chaque appel à une fonction de l'API.
// Acquisition d'un jeton d'authentification $token = AxiwayCampaign::authenticate($login,$password);Nous souhaitons double-poster l'inscription de Monsieur John Smith, identifié par le numéro de membre 943, dont l'email est john@example.com, et qui est né le 23 août 1976.
Nous préparons donc la structure de données qui va permettre d'enregistrer ces informations dans Emailing Director. Pour chaque colonne de la table de destination, nous indiquons la donnée qui doit y être enregistrée.
$membre = array( array( 'column' => 'id', 'value' => 943 ), array( 'column' => 'nom', 'value' => 'Smith' ), array( 'column' => 'prenom', 'value' => 'John' ), array( 'column' => 'email', 'value' => 'john@example.com' ), array( 'column' => 'naissance', 'value' => '1976-08-23' ) );Puis, on demande l'enregistrement de ces données, en indiquant la table de destination (ici la table "membres").
AxiwayDatabase::insertRecord( $token, // Jeton d'authentification 'membres', // La table dans laquelle on va ajouter le membre $membre // Données à insérer );
Pour la documentation complète et d'autres exemples, rendez-vous sur api.axiway.com/services
N'hésitez pas à nous contacter si vous avez besoin de compléments d'informations.
