sendeffect API

Transkript

1 sendeffect API

2 Voraussetzungen Um die sendeffect XML API benutzen zu können benötigen Sie PHP oder höher. Mögliche Abfragen Dieser Abschnitt beschreibt die verschiedenen Funktionen, die in der sendeffect XML API verfügbar sind. Empfänger zu einer Liste hinzufügen Die XML-Dokumentenstruktur zum hinzufügen eines Empfängers und zugehörigen benutzerdefinierten Details ist wie folgt: xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype Name der betroffenen API-Datei (Erforderlich) requestmethod Name der aufgerufenen Funktion (Erforderlich) details (Erforderlich) address -Adresse des hinzuzufügenden Kontaktes (Erforderlich) mailinglistid Die Kontaktliste des hinzuzufügenden Kontaktes (Erforderlich) confirmed Status des Kontaktes auf bestätigt setzen (yes oder y oder true oder 1) (Nicht erforderlich, standardmäßig nicht bestätigt) format Das Format der s an den Kontakt (html oder h oder text oder t) (Standardmäßig text) customfields item fieldid ID des hinzuzufügenden benutzerdef. Feldes. value Der Wert für das hinzuzufügende benutzerdef. Feld.

3 Antwort bei Erfolg Nach einem gültigen Befehl wird ein Kontakt eingefügt und seine ID in folgendem Format zurückgegeben: status Bei erfolgrecher Durchführung: SUCCESS data ID des Kontaktes Beispiel (XML) <xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>addsubscribertolist</requestmethod> <mailinglist>1</mailinglist> <format>html</format> <confirmed>1</confirmed> <customfields> <item> <fieldid>1</fieldid> <value>max Mustermann</value> </item> </customfields>

4 Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>addsubscribertolist</requestmethod> < address> @beispiel.de</ address> <mailinglist>1</mailinglist> <format>html</format> <confirmed>1</confirmed> <customfields> <item> <fieldid>1</fieldid> <value>max Mustermann</value> </item> </customfields> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage."; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { echo 'Daten: ', $xml_doc->data, '<br/>'; else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

5 Antwort bei fehlerhafter Abfrage Im Beispiel fehlt der öffnende details -Tag sowie die listid. Die XML-Struktur für dieses Beispiel: xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich) Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. In diesem Beispiel erhalten Sie die Fehlermeldung: The XML you provided is not valid. Please check your xml document and try again. Das Format ist wie folgt: status Wert ERROR errormessage Mitteilung zum Fehlergrund Beispiel (XML) <xmlrequest> <requesttype>lists</requesttype> <requestmethod>getlists</requestmethod>

6 Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>lists</requesttype> <requestmethod>getlists</requestmethod> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?> User-Token auf Gültigkeit prüfen Beachten Sie, dass der details -Tag in dem Beispiel vorhanden ist, obwohl keine Informationen benötigt werden. xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich)

7 Antwort bei Erfolg Bei Erfolg gibt die XML API true zurück. Das Format ist wie folgt: status Bei Erfolg: SUCCESS data Bei gültigkeit: 1 Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. In diesem Beispiel erhalten Sie die Fehlermeldung: Invalid details Das Format ist wie folgt: status Wert ERROR errormessage Mitteilung zum Fehlergrund Beispiel (XML) <xmlrequest> <requesttype>authentication</requesttype> <requestmethod>xmlapitest</requestmethod>

8 Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>authentication</requesttype> <requestmethod>xmlapitest</requestmethod> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

9 Empfänger löschen Dieses Beispiel löscht einen Empfänger von einer Liste. xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich) list ID der Kontaktliste in der gesucht werden soll (Erforderlich) address -Adresse des zu löschenden Kontaktes (Erforderlich) Antwort bei Erfolg status Wert: SUCCESS data item Anzahl gelöschter Empfänger. Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. status Wert: ERROR errormessage

10 Beispiel (XML) <xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>deletesubscriber</requestmethod> <list>1</list> Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>deletesubscriber</requestmethod> < address> @beispiel.de</ address> <list>1</list> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

11 Benuterdefinierte Daten abrufen xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich) listids Die IDs der Listen, deren benutzerdef. Daten abgerufen werden sollen. (Erforderlich) Antwort bei Erfolg status Wert: SUCCESS data item fieldid ID des benutzerdef. Feldes name Name des benutzerdef. Feldes fieldtype Datentyp (Zahl, Text, etc.) des benutzerdef. Feldes defaultvalue Standardwert des benutzerdef. Feldes required Zeigt, ob das benutzerdef. Fald erforderlich ist oder nicht fieldsettings Einstellungen des benutzerdef. Feldes in serialisierter Form Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. status Wert: ERROR. errormessage

12 Beispiel (XML) <xmlrequest> <requesttype>lists</requesttype> <requestmethod>getcustomfields</requestmethod> <listids>1</listids> Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>lists</requesttype> <requestmethod>getcustomfields</requestmethod> <listids>1</listids> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

13 Empfänger abrufen Dieses Beispiel ruft alle Kontakte einer Kontaktliste ab. xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich) searchinfo List ID der Kontaktliste (Erforderlich) -Adresse nach der gesucht werden soll (Erforderlich) Antwort bei Erfolg status Wert: SUCCESS data count Anzahl von Empfängern. subscriberlist Liste von -Adressen. Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. status Wert: ERROR errormessage

14 Beispiel (XML) Folgendes Beispiel sucht nach empfängern mit der Domain beispiel.de in der Kontaktliste mit der ID 1. <xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>getsubscribers</requestmethod> <searchinfo> <List>1</List> </searchinfo> Beispiel (PHP) <?php $xml = '<xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>getsubscribers</requestmethod> <searchinfo> <List>1</List> < >@yourdomain.com</ > </searchinfo> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

15 Kontakt Vorhanden Dieses Beispiel prüft, ob ein Kontakt auf einer Kontaktliste vorhanden ist. xmlrequest (Erforderlich) username (Erforderlich) usertoken (Erforderlich) requesttype (Erforderlich) requestmethod (Erforderlich) details (Erforderlich) -Adresse des Kontaktes (Erforderlich) List ID der Kontaktliste (Erforderlich) Successful Response status Wert: SUCCESS data Gibt 1 zurück, wenn der Kontakt existiert Fehlerantwort Im Fehlerfall wird eine Antwort per XML gesendet, die Informationen zum Fehler enthält. status Wert: ERROR errormessage

16 Beispiel (XML) <xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>issubscriberonlist</requestmethod> <listids>1</listids> Beispiel (PHP) <?php $xml = ' <xmlrequest> <requesttype>subscribers</requesttype> <requestmethod>issubscriberonlist</requestmethod> < address> @beispiel.de</ address> <listids>1</listids> '; $ch = curl_init(' curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $result if($result === false) { echo "Fehler bei Abfrage"; else { $xml_doc = simplexml_load_string($result); echo 'Status: ', $xml_doc->status, '<br/>'; if ($xml_doc->status == 'SUCCESS') { print_r($result); else { echo 'Fehler: ', $xml_doc->errormessage, '<br/>';?>

17 Ihr Ansprechpartner für API Silvan Usleber +49 (0) Social-Network plus.google.com/+sendeffectde