API REST V4 (Open API Initiative)

Cette documentation vous est proposé au format Open API; vous pouvez générer différents clients (PHP, Android, C#, .NET, Javascript…) en ouvrant ce fichier de définition d'API dans l'éditeur swagger de l'initiative.

Tous les appels à l'API REST nécessitent une authentification. Pour cela, nous utilisons la méthode d'authentification spécifiée par la rfc2617.

La méthode consiste a renseigner le numéro de compte (affiché dans l'interface du compte en haut à gauche) et une clé api valide (que vous aurez générée préalablement dans la rubrique Plus > Paramètres > API et Connecteurs) lors de chaque appel à l'api sous la forme « MB_ACCOUNT_ID:MB_API_KEY ».

Les appels à l'api se font en https avec la racine suivante : https://services.message-business.com/api/rest/v4/

• Voir les exemples d’appel avec authentification
  Exemple curl sous shell

  curl -s --user "MB_ACCOUNT_ID:MB_API_KEY" -X GET 'https://services.message-business.com/api/rest/v4/Segment'

  Exemple PHP utilisant la lib curl

  $MB_ACCOUNT_ID = 'Your_numerical_account';
  		$MB_API_KEY = 'Your_api_key';
  		$curl_handle = curl_init();
  		curl_setopt($curl_handle, CURLOPT_URL, $url);
  		curl_setopt($curl_handle, CURLOPT_USERAGENT, 'MessageBusinessApi/1; PHP v. ' . phpversion());
  		curl_setopt($curl_handle, CURLOPT_USERPWD, $MB_ACCOUNT_ID.':'.$MB_API_KEY);
  

Listes des méthodes

Limitations des différents appels API suivants:
– contacts/purge/add /contacts/export/add /contacts/import/add /contacts/attribute : 2 appels par seconde maximum,
– contacts/import/emailing/operation : 1 appel par seconde,
– 30 appels par seconde maximum pour les autres appels API.