Vous êtes ici Resources Guide d'utilisateur Informations sur l'API

API Documentation

PHP

Le PHP n'a pas d'habillage SOAP intégré, donc l'exemple nous utilisons, PHP_SOAP.dll, sera pour la plupart du temps accompagné d'installations LAMP.
 
Pour activer cet habillage SOAP, vous devez modifier votre fichier php.ini pour y inclure une extension = php_soap.dll
Vous aurez également besoin de vous assurer que le fichier php_Soap.dll se trouve dans votre répertoire ext.
Nous allons commencer avec une simple extraction decampagne. Pour se faire, le code est :



Ce code définie le nom d'utilisateur, mot de passe et campaignId : ces trois arguments sont nécessaires pour la méthode GetCampaign. Il insert ensuite les arguments dans un tableau qui est lui aussi intégré dans la méthode. Celle-ci crée alors un objet appelé résultat. L'objet résultat est ensuite décomposé en éléments constitutifs
 
Le code ci-dessous vous permet de retourner un contact par une adresse mail.
 
Le résultat obtenue est un objet de contact que vous devez traiter comme un tableau d'objets. Pour obtenir des données issues de ce tableau vous devez :
 



Ensuite, vous pouvez parcourir les deux tableaux pour obtenir toutes les données dont vous avez besoin :



Pour insérer des données dans BrotherMailer via l'API la méthode est similaire. Le code ci-dessous vous permet d'insérer un contact dans BrotherMailer



Vous remarquerez peut-être sur le code ci-dessus l'utilisation de la variable "Builder"

Si vous avez des difficultés à utiliser ces codes, contactez-nous sur support@brothermailer.com

.NET

Utiliser l'API. NET est très simple. Vous aurez besoin d'ajouter l'API comme référence Web dans Visual Studio. Ce document va vous montrer comment utiliser la référence. NET Web 2.0 à la place de la nouvelle procédure de 3,0 référence.
Vous pouvez y accéder par un clic droit, cliquez sur «Ajouter une référence de service» puis cliquez sur le bouton "avancé" en bas :
 

Puis cliquez sur :



Cela affichera cela sur votre écran. L'URL à entrer est http://apiconnector.com
- Si cela réussit, vous devriez voir les précisions suivantes, puis cliquez simplement sur Ajouter une référence.



La référence de l'API Web aura alors été ajouté.
 
Maintenant vous pouvez commencer à créer votre intégration.
 
Dans un premier temps, utilisez les données "de retour" car se sont les plus simples. L'exemple ci-dessous vous montre comment récupérer une campagne qui est déjà sur BrotherMailer



Le diagramme ci-dessous vous montre le détails de la structure de la création d'un  de l'API

Cette classe est assez explicite, elle crée une instance de l'API et l'appelle la méthode getCampaign avec les arguments nécessaires. Cela fera de la campagne un objet de campagne appelé "campagne". Ainsi vous pouvez obtenir l'information sur la campagne, tel que
 
string HTML = campaign.HTMLContent;
 
Cela va créer un appel string HTML avec le code HTML de la campagne, vous serez en mesure de faire cela pour la totalité du contenu de la campagne (pour voir la structure de l'un des objets, consulter le site apiconnector.com )
 

Ou vous pouvez regarder l'objet de campagne en exemple :



La même structure de classe est utilisée pour récupérer des données pour d'autres objets, par exemple un contact

 



Avec l'objet contact, vous remarquerez que les zones de données sont un objet dans l'objet contact par

exemple



Les zones de données des contacts objets ont deux tableaux : l'un appelé "touches", qui contient les noms des champs des données, et l'autre appelé "valeurs", qui contient des objets. Les objets contiennent les valeurs du champ données, il peut contenir des strings, ints, des Booleans et des dates.
 

Vous pouvez obtenir leurs valeurs par:



Vous pouvez recommencer la manipulation afin de relever les valeurs.
 

L'insertion de données exigera plus de code puisque vous devez remplir les champs domaines avant que vous utilisiez la méthode. Ci-dessous, la méthode pour insérer une campagne :


 L'ajout d'un contact se fait de la même façon, sauf si vous avez besoin d'insérer un objet dans le champs de donnée. Pour se faire voici le code : 

 



Ce sont des méthodes de base de l'API . NET, si vous des problèmes avec celles-ci alors s'il vous plaît contactez support@brothermailer.fr

 

L'interface SOAP

L'API BrotherMailer utilise une interface SOAP et est remarquablement facile à utiliser. Vous pouvez trouver des détails sur les méthodes d'utilisation sur http://apiconnector.com. Si vous n'avez pas ou peu d'expérience avec SOAP, vous devriez regarder les liens suivants:

http://en.wikipedia.org/wiki/SOAP
http://www.w3schools.com/soap/default.asp



Vous pouvez utiliser l'API comme vous le souhaitez, que ce soit pour synchroniser vos donnés sur votre CRM, télécharger et envoyer de campagnes, gérer des données, etc. Ce document va vous montrer comment utiliser les méthodes en C #, PHP et ASP classiques.
 

Le nom d'utilisateur et mot de passe dont vous avez besoin pour utiliser l'API doit être généré en ligne. Vous pouvez en créer un dans votre compte BrotherMailer. Lorsque vous vous connectez à votre compte, vous pouvez aller à la rubrique "Mon Compte" située en haut à droite de votre écran :

 

My account

Cliquez sur manage users:

Manage users

Cliquez sur  “add new”, cet écran apparait :

Add new



Vous devez vous assurer que l'autorisation d'accès API est sélectionnée, puis enregistrer le compte.
 
Vous serez alors en mesure d'utiliser ces informations pour vous connecter à l'API.
 
L'API peut être utilisée à différentes fins, dont la gestion des contacts. Pour apprendre à utiliser les fonctions au sein de l'API, vous aurez besoin de connaître la structure des objets, et plus particulièrement de l'objet de contact qui ressemble à ceci :
 
 

Contact object

Ceci est un type standard de l'objet SOAP contenant des données basiques. La seule partie qui pourrait s'avérer complexe est la zone de données "les champs de valeurs" car il s'agit de données de type flexible. De ce fait, vous aurez besoin de spécifier le type de valeur que vous voulez utiliser. Plus loin dans les exemples de code, nous vous expliquerons comment procéder.

Vous pouvez voir d'autres exemples de structures ici http://apiconnector.com

La meilleure façon d'apprendre à utiliser l'API est de s'entraîner au cours de simulations.