Premiers pas avec l'API MemberMouse

URL de l'API et informations d'identification

La première chose dont vous avez besoin pour utiliser l'API MemberMouse est l'URL de l'API et les informations d'identification. Dans l'interface Souris du membre aller dans le menu Outils du développeur et cliquez sur l'icône Onglet Références API. Sur cette page, vous pouvez voir l'URL de l'API et créer et gérer les informations d'identification de l'API.

Exécution d'un appel API

In order to make an API call you’ll need to make a request to the API call URL and pass the appropriate input parameters. The API call URL and input parameters will vary based on the API call being made. See this article for une liste des appels API dans MemberMouse et cliquez sur un appel API pour afficher l'URL associée et les paramètres d'entrée.

Télécharger un exemple de code pour PHP

Vous trouverez ci-dessous un exemple d'appel API pour créer un nouveau membre à l'aide de la fonction appel API createMember.

First, we’re setting the input parameters as a string of name/value pairs separated by an & et stockées dans le $inputParams variable.

Next, we’re setting the API call URL and initializing a instance cURL.

Finally, we’re executing the cURL instance, decoding the result of the call and storing it in a $data et de l'afficher à l'écran.

$inputParams = "apikey={Votre_clé_API}&apisecret={Votre_secret_API}&" ;
$inputParams .= "first_name=Tom&" ;
$inputParams .= "last_name=Smith&" ;
$inputParams .= "[email protected]&" ;
$inputParams .= "phone=(212) 555-7864&" ;
$inputParams .= "membership_level_id=2&" ;

$apiCallUrl = "https://{Votre_URL_API}?q=/createMember" ;
$ch = curl_init($apiCallUrl) ;

curl_setopt($ch, CURLOPT_POST, 1) ;
curl_setopt($ch, CURLOPT_POSTFIELDS, $inputParams) ;
curl_setopt($ch, CURLOPT_HEADER, 0) ;
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1) ;
$result = curl_exec($ch) ;
curl_close($ch) ;

echo "RAW Response : ".$result."<br />" ;
$data = json_decode($result) ;
echo "<pre>" ;
var_dump($data-&gt;response_data) ;
echo "</pre>"; 

To modify this for different API calls you’ll need to change the API call URL and input parameters according to the documentation for the API call you’re making.

mod_security Blocage des demandes

Sur certains serveurs, vous pouvez constater que les appels à l'API sont rejetés par le serveur. Ce phénomène est généralement lié aux paramètres de sécurité du serveur, tels que mod_security. Pour contourner ce problème, vous pouvez essayer de passer des en-têtes supplémentaires à la requête cURL pour simuler qu'elle vienne d'un vrai navigateur, comme suit :

$headers = array(
'Referrer : http://yourdomain.com',
'User-Agent : Mozilla/5.0 (X11 ; Ubuntu ; Linux i686 ; rv:28.0) Gecko/20100101 Firefox/28.0'
) ;
curl_setopt($ch,CURLOPT_HTTPHEADER,$headers) ; 

Bien sûr, vous voudrez remplacer http://yourdomain.com par votre domaine réel.

Accès au code de réponse

Dans l'exemple de demande ci-dessus, le json_decode() est utilisée pour analyser l'objet résultat de l'appel API et le stocker dans le fichier $data variable. À ce stade, le code de réponse peut être consulté de la manière suivante :

$data->response_code ;

Voir cet article pour une liste des appels API dans MemberMouse et cliquez sur un appel API pour afficher les codes de réponse associés.

Accès aux données de réponse

Dans l'exemple de demande ci-dessus, le json_decode() est utilisée pour analyser l'objet résultat de l'appel API et le stocker dans le fichier $data variable. À ce stade, il est possible d'accéder aux données de réponse de la manière suivante :

$data->response_data->username ;
$data->response_data->password ;
$data->response_data->email ;

Où Nom d'utilisateur, mot de passe et courriel sont des paramètres valides dans l'objet de données de la réponse. La liste des paramètres valides varie en fonction de l'appel API effectué. Voir cet article pour une liste des appels API dans MemberMouse et cliquez sur un appel API pour afficher les données de réponse associées.

Télécharger un exemple de code pour Python