API-URL und Anmeldeinformationen
Um die MemberMouse-API verwenden zu können, benötigen Sie zunächst die API-URL und die Anmeldedaten. In der MitgliedMaus Menü gehen zu Entwickler-Tools und klicken Sie auf das Registerkarte API-Anmeldeinformationen. Auf dieser Seite können Sie Ihre API-URL einsehen und API-Anmeldeinformationen erstellen und verwalten.
Ausführen eines API-Aufrufs
Um einen API-Aufruf zu tätigen, müssen Sie eine Anfrage an die API-Aufruf-URL stellen und die entsprechenden Eingabeparameter übergeben. Die API-Aufruf-URL und die Eingabeparameter variieren je nach dem durchgeführten API-Aufruf. Siehe diesen Artikel für eine Liste der API-Aufrufe in MemberMouse und klicken Sie auf einen API-Aufruf, um die zugehörige URL und die Eingabeparameter anzuzeigen.
Beispielcode für PHP herunterladen
Nachfolgend ein Beispiel für einen API-Aufruf zur Erstellung eines neuen Mitglieds unter Verwendung der createMember API-Aufruf.
Zunächst setzen wir die Eingabeparameter als Zeichenkette von Name/Wert-Paaren, die durch ein &
und gespeichert in der $inputParams
variabel.
Als Nächstes legen wir die URL für den API-Aufruf fest und initialisieren eine cURL-Instanz.
Schließlich führen wir die cURL-Instanz aus, dekodieren das Ergebnis des Aufrufs und speichern es in einer $data
und gibt sie dann auf dem Bildschirm aus.
$inputParams = "apikey={Ihr_API_Key}&apisecret={Ihr_API_Geheimnis}&";
$inputParams .= "vorname=Tom&";
$inputParams .= "nachname=Schmied&";
$inputParams .= "[email protected]&";
$inputParams .= "Telefon=(212) 555-7864&";
$inputParams .= "mitgliedschaft_level_id=2&";
$apiCallUrl = "https://{Ihre_API_URL}?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-Antwort: ".$result."<br />";
$data = json_decode($result);
echo "<pre>";
var_dump($data->Response_data);
echo "</pre>";
Um dies für verschiedene API-Aufrufe zu ändern, müssen Sie die URL des API-Aufrufs und die Eingabeparameter entsprechend der Dokumentation für den jeweiligen API-Aufruf ändern.
mod_security Blockieren von Anfragen
Auf manchen Servern kann es vorkommen, dass API-Aufrufe vom Server abgewiesen werden. Dies hängt in der Regel mit den Sicherheitseinstellungen des Servers zusammen, z. B. mod_security. Um dies zu umgehen, können Sie versuchen, zusätzliche Header an die cURL-Anfrage zu übergeben, um zu simulieren, dass sie von einem echten Browser kommt, wie folgt:
$headers = array(
'Referrer: http://yourdomain.com',
'Benutzer-Agent: Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:28.0) Gecko/20100101 Firefox/28.0'
);
curl_setopt($ch,CURLOPT_HTTPHEADER,$headers);
Natürlich sollten Sie http://yourdomain.com durch Ihre eigentliche Domäne ersetzen.
Zugriff auf den Antwortcode
In der obigen Beispielanforderung ist die json_decode()
Methode wird verwendet, um das Ergebnisobjekt des API-Aufrufs zu analysieren und es in der $data
Variable. An dieser Stelle kann auf den Antwortcode wie folgt zugegriffen werden:
$data->Antwort_code;
Siehe diesen Artikel für eine Liste der API-Aufrufe in MemberMouse und klicken Sie auf einen API-Aufruf, um die zugehörigen Antwortcodes anzuzeigen.
Zugriff auf Antwortdaten
In der obigen Beispielanforderung ist die json_decode()
Methode wird verwendet, um das Ergebnisobjekt des API-Aufrufs zu analysieren und es in der $data
Variable. An dieser Stelle kann auf die Antwortdaten wie folgt zugegriffen werden:
$data->Antwort_data->Benutzername;
$data->Antwort_data->Passwort;
$data->response_data->email;
Wo Nutzername
, Passwort
und E-Mail
sind gültige Parameter im Antwortdatenobjekt. Die Liste der gültigen Parameter hängt vom jeweiligen API-Aufruf ab. Siehe diesen Artikel für eine Liste der API-Aufrufe in MemberMouse und klicken Sie auf einen API-Aufruf, um die zugehörigen Antwortdaten anzuzeigen.