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

API Documentation

PHP

PHP n'a pas d'habillage SOAP intégré, donc dans l'exemple nous utilisons PHP_SOAP.dll qui sera dans la plupart des 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 trouve dans votre répertoire ext
Nous allons commencer avec une simple extraction d'une campagne. Le code pour ce faire est



Ce code est d'abord définir le nom d'utilisateur, mot de passe et campaignId, les trois arguments sont nécessaires avec la méthode GetCampaign. Puis il construit les arguments dans un tableau et passe ce tableau dans la méthode qui renvoie le résultat comme un objet appelé résultat. L'objet résultat est ensuite décomposé en éléments constitutifs
 
Le code ci-dessous est à retourner un contact par e-mail
 
La variable du résultat est un objet de contact dont vous avez besoin pour gérer comme un tableau d'objets, pour obtenir les données de ce dont vous avez besoin



Ensuite, vous pouvez parcourir les deux tableaux pour y obtenir toutes les données.



Pour insérer des données dans BrotherMailer via l'API c'est similaire; le code ci-dessous est la façon pour insérer un contact dans BrotherMailer



Ce que vous remarquerez peut-être sur le code ci-dessus c'est l'utilisation de la variable "Builder"

Si vous avez des difficultés à utiliser ce alors s'il vous plaît contactez 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 voir cela par un clic droit dans ​​le projet et 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
 
Pour les premières méthodes, nous irons à travers les données "de retour", car ces méthodes sont les plus simples dans leur structure. L'exemple ci-dessous vous montre comment récupérer une campagne qui est déjà en BrotherMailer



Le diagramme ci-dessous vous montre le détails de la structure de la création de l'instance 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. Il fera de la campagne un objet de campagne appelée campagne. Ainsi vous pourriez l'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 quelconque 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 est un tableau de chaînes qui contient les noms des champs des données, et un tableau des valeurs qui est un tableau d'objets. Les objets des valeurs contient les valeurs de la champs données, il est un tableau d'objets comme il est capable de contenir des strings, ints, les Booleans et les dates.
 

Vous pouvez obtenir leurs valeurs par:



Ensuite, vous pouvez parcourir les tableaux pour obtenir les valeurs de sortie.
 

Inserer des données demande plus de code que vous devez remplir les champs avant d'appeler la méthode, la méthode ci-dessous est l'insertion d'une campagne



Insertion d'un contact est effectuée de la même manière, sauf qu'en plus vous avez l'objet à insérer. Le code pour cela ressemble à ceci : 



Ce sont des méthodes de base de l'API . NET, si vous trouvez que vous avez 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 sur http://apiconnector.com. Si vous n'avez pas ou peu d'expérience avec SOAP, vous pouvez 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 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 etre générez 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" en haut à droite de votre écran

 

My account

Cliquez sur manage users:

Manage users

Et cliquez sur  “add new” et cet écran apparait

Add new



Vous devez vous assurer que l'autorisation d'accès API est sélectionné, 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 principale sera 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 l'objet de contact qui ressemble ceci :
 

Contact object

Ceci est un type standard de l'objet SOAP, ayant des types de données normale en son sein. La seule partie de ce qui peut s'avérer complexe est la zones de données - les champs de valeurs. C'est parce qu'ils sont de type flexible. En raison de cela, vous aurez besoin de spécifier le type de valeur que vous voulez utiliser. Vous verrez comment faire cela plus loin dans les exemples de code.

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

La meilleure façon d'apprendre à utiliser l'API est de le pratiquer avec des exemples.