Getting started

Vous pouvez interagir avec la plateforme Beemailing par le biais de notre API REST (HTTPS) depuis votre application.

Généralités

End Point	https://my.beemailing.com/api.php
Méthode d’appel	GET ou POST

Paramètres à transmettre

Ci-dessous vous sont indiqués les paramètres à transmettre systématiquement dans tous vos appels API.

Il sera nécessaire d’ajouter à ceux-ci les paramètres spécifiques à la commande que vous souhaitez exécuter.

Paramètre	Description	Exemples ou format
ApiKey	Clé API à générer depuis l’espace utilisateur Beemailing	xxxx-xxxx-xxxx-xxxx-xxxx
ResponseFormat	Format de la réponse	JSON, XML
Command	Commande à exécuter	email.create

Réponse de l’API

L’API répond au format JSON ou XML, selon la valeur spécifiée dans le paramètre ResponseFormat lors de l’appel.

Les informations suivantes seront systématiquement transmises en retour. À cela s’ajouteront les valeurs de retours spécifiques à la commande exécutée.

Clé	Description	Valeurs possibles
Success	Indique si la commande a été exécutée avec succès.	true, false
ErrorCode	Code d’erreur (le cas échéant)	0, 400, 401, 404, 500

Certaines commandes incluent également une clé « ErrorMessage » qui donnera, dans la mesure du possible, plus de précisions sur l’erreur rencontrée.

Exemple d’appel API

Par exemple, l’appel à l’URL suivante aura pour effet de créer une campagne ayant pour nom « Ma super campagne », et d’afficher la réponse au format JSON (la valeur ApiKey est une valeur factice) :

https://my.beemailing.com/api.php?ApiKey=AAAA-BBBB-CCCC-DDDD-EEEE-FFFF&ResponseFormat=JSON&Command=Campaign.Create&CampaignName=Ma%20super%20campagne

Les noms de paramètres ne sont pas sensibles à la casse.

Les paramètres peuvent être transmis en GET ou en POST. Notez que l’envoi en POST permet l’envoi de données plus volumineuses.