API-Handbuch. Einführung, Dokumentation und Fallbeispiele. Stand: 4. Dezember Copyright dialogue1 GmbH, D Hamburg. Version 2.4.

Transkript

1 API-Handbuch Einführung, Dokumentation und Fallbeispiele Stand: 4. Dezember 2012 Copyright dialogue1 GmbH, D Hamburg Alle Rechte vorbehalten, auch die der Übersetzung, der fotomechanischen Wiedergabe und der Speicherung, auch in elektronischen Medien. Nachdruck, auch auszugsweise, nur mit schriftlicher Genehmigung vom Inhaber des Copyrights. Bei der Zusammenstellung von Texten und Abbildungen wurde mit größter Sorgfalt vorgegangen. Trotzdem können Fehler nicht vollständig ausgeschlossen werden. Der Herausgeber kann für fehlerhafte Angaben und deren Folgen weder eine juristische Verantwortung noch irgendeine Haftung übernehmen. Die dialogue1 GmbH behält sich vor, die beschriebenen Funktion ohne vorherige Ankündigung im Zuge der Weiterentwicklung zu verändern bzw. anzupassen. Für Verbesserungsvorschläge und Hinweise auf Fehler ist sie ebenfalls sehr dankbar. Änderungen vorbehalten.

2 Inhaltsübersicht 1 Einleitung Die Amity-Schnittstelle im Überblick Grundsätzlicher Aufruf Ausgabeformat und Statuscodes Systemintegration Zugriff auf Ressourcen mit Beispielen Kontakte Anzeigen Anlegen Bearbeiten Suchen Löschen Listen Anlegen Bearbeiten Löschen Ordner Anzeigen Anlegen Bearbeiten Newsletter Anlegen einer neuen HTML-Vorlage Anlegen einer neuen Multipart-Vorlage Versand anlegen Reporting Bouncer Zugriff auf sonstige Ressourcen Anmerkungen und Tipps Abschlussbemerkung und Ausblick dialogue1 GmbH Seite 1 von 18

3 1 Einleitung Die API (Application Programming Interface) stellt eine externe Steuerungsschnittstelle zu amity dar. Der Funktionsumfang entspricht nahezu den Möglichkeiten des operativen Benutzers über die GUI. Die API verfolgt das REST Prinzip (Represential State Transfer) und ähnelt damit der Struktur des WWW. Dies bedeutet, dass eine Ressource immer eindeutig durch die API angesprochen werden kann. Dabei stellen diese Ressourcen jeweils einzelne logische Entitäten Ihres Datenbestandes innerhalb von amity dar, z.b. Kontakte, Listen oder Mailings. Mit der Art des Aufrufes der API und vor allem den Parametern entscheiden Sie darüber, was mit diesen Ressourcen geschehen soll - die Übergabe von Parametern erfolgt dabei im flexiblen XML- Format. Im Folgekapitel 2 erhalten Sie zunächst einen Überblick darüber, wie die API aufgerufen wird. Kapitel 3 zeigt dann anhand von praxisnahen Beispielen in der Programmiersprache PHP den genauen Zugriff auf die unterschiedlichen Ressourcen. In Kapitel 4 hat unser Support-Team neben hilfreichen Tipps und Tricks die häufigsten Fehlerursachen und passende Lösungswege zusammengestellt. Den Ausblick auf geplante, zukünftige Funktionen bietet das abschließende Kapitel 5. dialogue1 GmbH Seite 2 von 18

4 2 Die Amity-Schnittstelle im Überblick Die API von Amity ermöglicht Ihnen eine nahtlose Integration in Ihre bestehende IT-Infrastruktur. Einen grundlegenden Überblick über die Möglichkeiten zeigt Ihnen dieses Kapitel. 2.1 Grundsätzlicher Aufruf Der Aufruf der API definiert sich folgendermaßen: http(s)://[host]/api/[mandantenid]/[ressource]/[parameter]?[parameter]&usr=[benutzername]& psw=[passwort] [Host] ist der Hostname der amity-instanz (ggfs. wird dieser über das SSL-Protokoll https aufgerufen [MandantenID] ist die jew. Mandanten-ID [Ressource] ist der Pfad der Ressource (z.b. contact oder list) [Parameter] sind die ggf. benötigten Parameter [Benutzername] und [Passwort] dienen der Authentifizierung Die API bedient sich des HTTP Protokolls zum Datenaustausch. Dieses Protokoll definiert vier Operatoren: 1.) GET Lesen einer Ressource (bzw. der Repräsentation im Protokoll) 2.) POST Hinzufügen von Informationen zu einer Ressource 3.) PUT Anlegen einer Ressource 4.) DELETE Löschen einer Ressource Nur die GET -methode kann direkt im Browser eingegeben werden; die Übertragung eines API- Aufrufs per POST oder PUT erfordern weitere Daten im XML-Format. BITTE BEACHTEN ES IST SEHR WICHTIG, DASS FÜR DEN ZUGRIFF AUF EINE BESTIMMTE RESSOURCE AUCH DER KORREKTE OPERATOR (GET,POST,PUT) BENUTZT WIRD! 2.2 Ausgabeformat und Statuscodes Das API-Skript quittiert jeden Aufruf mit der Rückgabe eines Statuscodes wie z.b. 200 oder 409. Diese entsprechen der im WWW bekannten Syntax: a. Beginn mit 2 : Eingabe verstanden und Operation durchgeführt b. Beginn mit 4 : Eingabe verstanden, aber Operation konnte nicht durchgeführt werden (normaler Fehler) c. Beginn mit 5 : Eingabe nicht verstanden, es kann keine Operation durchgeführt werden (Ausnahmefehler). dialogue1 GmbH Seite 3 von 18

5 Im Überblick: - 200: OK - 201: Ressource erstellt - 202: Eingabe akzeptiert - 400: Fehlerhafter Aufruf - 401: Unzureichende Zugriffsrechte (Benutzer nicht bekannt) - 403: Unzureichende Zugriffsrechte (Benutzer hat keine Zugriffsrechte auf die Ressource) - 404: Ressource nicht gefunden - 409: Ressource existiert bereits oder kann nicht angelegt werden - 500: Interner Fehler (Zugriff nicht verarbeitet) - 501: Operation nicht wird nicht unterstützt - 503: API nicht verfügbar Die eigentliche Ausgabe der geforderten Daten erfolgt im XML-Format. 2.3 Systemintegration Folgende Grafik visualisiert die Möglichkeiten und Einsatzzwecke: Die API-Schnittstelle von Amity im Überblick Über die sog. API-Schnittstelle (englisch application programming interface (API), deutsch Schnittstelle zur Anwendungsprogrammierung ) ermöglicht amity den schnellen und einfachen Datenaustausch mit unterschiedlichen Anwendungen unserer Kunden. Anwendung des Kunden z.b. CMS, CRM, DW etc. Export Generierte HTML- und/oder MultiPart- s mit personalisierten Feldern und Platzhaltern Neue Empfängerdaten Anlegen von Empfängerlisten Aktualisierung von Kontaktdaten, z.b. Adressänderungen oder Zuweisung zu einer neuen Empfängerliste Versand einleiten Import Aktualisierte Kundendaten, z.b. adressen, Abonnements von Listen Bouncer auslesen und ggf. Empfänger sperren Detaillierte Empfangsstatistiken (in der Entwicklung) -Versand und Opt-In s von neuen Kunden Der Datenaustausch erfolgt im XML-Format. Diese Schnittstelle wird kontinuierlich weiterentwickelt. Individuelle Anpassungen an spezielle Kundenwünsche sind möglich. Die Webanwendung stellt zudem weitere Im- und Exportfunktionen zur Verfügung (z.b. CSV-Daten aus Excel etc.) Stand: 30. Oktober 2012 dialogue1 GmbH Seite 4 von 18

6 3 Zugriff auf Ressourcen mit Beispielen In diesem Kapitel werden die Zugriffsfunktionen auf bestimmte Ressourcen in Amity beschrieben. Dazu werden leicht nachvollziehbare, praxisnahe Quellcode-Beispiele dargestellt. Diese Code- Beispiele sind im prozeduralen Stil in PHP verfasst. Tipps zur Auswertung des Ergebnisses eines API-Aufrufs erhalten sie in Kapitel 4 Anmerkungen und Tipps. 3.1 Kontakte Anzeigen Anhand der Amity-KontaktID listet dieser Aufruf einen bestimmten Kontakt und dessen Attribute auf (der Zugriff erfolgt per GET): Ebenfalls kann anstelle der Amity-KontaktID per adresse auf einen Kontakt zugegriffen werden: Weiter besteht die Möglichkeit, die anzuzeigenden Attribute zu begrenzen in diesem Fall auf die Felder sowie Vor- und Nachnamen. Dies ist eine Möglichkeit, ressourcenschonend und performant zu arbeiten. &psw=[passwort] Beispielcode: $url = eheim"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_MUTE, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE); echo $http_status; echo $output; curl_close($ch); dialogue1 GmbH Seite 5 von 18

7 3.1.2 Anlegen Zum Anlegen eines Kontaktes wird diese PUT-Abfrage formuliert: Die Attribute des zu erstellenden Kontaktes werden im sog. Body der http-anfrage definiert und folgendermaßen mit Werten zu belegt: <contact> <field name= <field name= BIRTHDAY format= dd.mm.jj > </field> <field name='32_freifeldtext'>testtext</field> <lists> <list id= kn9n > <list id= hb23 > </lists> <events> <event id= kn9n > <event id= 234b > </events> </contact> Dieser Request erzeugt einen Kontakt mit der Adresse und dem 1. April 1972 als Geburtstag. Nachdem der Kontakt angelegt worden ist, wird er den Liste kn9n sowie hb23 zugeordnet. Zusätzlich wird der Prozess mit der ID kn9n ausgeführt. Beispielcode: $url = " "; $name = utf8_encode(htmlspecialchars("ü und Ä")); $xml_data = " <contact> <field name=' '>hans.meier@dialogue1.de</field> <field name='birthday' format= dd.mm.jj > </field> <field name='32_freifeldtext'>testtext</field> <lists> <list id='kn9n'></list> <list id='hb23'></list> </lists> <events> <event id='kn9n'></event> <event id='234b'></event> </events> </contact>"; $chlead = curl_init(); curl_setopt($chlead, CURLOPT_URL, $url); dialogue1 GmbH Seite 6 von 18

8 curl_setopt($chlead, CURLOPT_USERAGENT, 'Dialogue1Connector/1.4'); curl_setopt($chlead, CURLOPT_HTTPHEADER, array('content-type: application/json','content-length: '. strlen($xml_data))); curl_setopt($chlead, CURLOPT_VERBOSE, 1); curl_setopt($chlead, CURLOPT_RETURNTRANSFER, true); curl_setopt($chlead, CURLOPT_CUSTOMREQUEST, "PUT"); curl_setopt($chlead, CURLOPT_POSTFIELDS,$xml_data); curl_setopt($chlead, CURLOPT_SSL_VERIFYPEER, 0); $chleadresult = curl_exec($chlead); $chleadapierr = curl_errno($chlead); $chleaderrmsg = curl_error($chlead); $http_status = curl_getinfo($chlead, CURLINFO_HTTP_CODE); curl_close($chlead); echo $http_status; BEKANNTE FEHLERQUELLEN: - Die -Adresse bereits vorhanden: Es wird eine 409 Fehlermeldung ausgeben und der Kontakt nicht angelegt - Der Wert eines Feldes ist nicht valide: Es wird eine 409 Fehlermeldung ausgeben und der Kontakt nicht angelegt - Eine Liste nicht verfügbar: Der Kontakt wird angelegt. Die Zuordnung zu betreffenden Liste wird ignoriert. Es wird der 202-Code ausgeben. - Die direkte Verwendung von Umlauten ist nicht möglich; diese müssen wie im Beispielcode UTF8-kodiert werden. - Wird nur ein einzelnes Attributes innerhalb eines XML-Tags angegeben, z.b. nur ein <list id= xy > innerhalb des <lists> </lists>-blocks, empfehlen wir aus Kompatibilitätsgründen ein zusätzliches Feld FORCEMODE=1 hinzuzufügen. Ein Beispiel hierzu ist im folgenden Quelltext zu sehen Bearbeiten Das Bearbeiten eines Kontaktes wird per POST durchgeführt: Ebenfalls kann dieser Aufruf mit Hilfe der jew. -Adresse anstelle der ContactID durchgeführt werden. -Adresse] &usr=[benutzer]&psw=[passwort] dialogue1 GmbH Seite 7 von 18

9 Um die Attribute des Kontakts mit Werten zu belegen, verwenden Sie folgendes XML im Body der Abfrage: <contact> <field name= <field name= BIRTHDAY format= dd.mm.jj > </field>... <lists> <list id= kn9n > </lists> </contact> Der Kontakt übernimmt alle Attribute und wird den entsprechenden Listen zugeordnet. Sie können auf diese Weise auch Listenzuordnungen entfernen und/oder Prozesse ausführen: <contact> <field <field name='name2'>neuernachname</field> <lists> <list id='l99o8'></list> <list id='m007k'></list> </lists> <deletefromlists> <dellist id='l9bb8'></dellist> <dellist id='9i07k'></dellist> </deletefromlists> <events> <event id='lk9mo'></event> <event forcemode='1'></event> </events> </contact> Beispielcode: $url = " ; $xml_data = " <contact> <field name='name2'>oliver</field> <field name='name1'>gehrke</field> <field name='60_eigenes_feld_kundenid'>abc-4815-x4223</field> <lists> <list id='l99o8'></list> <list id='m007k'></list> </lists> dialogue1 GmbH Seite 8 von 18

10 <deletefromlists> <dellist id='129o8'></dellist> <dellist id='9ab74'></dellist> </deletefromlists> </contact>"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_MUTE, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_HTTPHEADER, array('content-type: text/xml')); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml_data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE); echo $http_status; curl_close($ch); echo $output; Suchen Die Suche nach einem oder mehreren Benutzern ist per folgender GET-Abfrage möglich: &usr=[benutzer]&psw=[pw] Es kann ebenfalls nach einem Ausschnitt der adresse gesucht werden. Dafür müssen Sie diesen Suchstring mit einem % kennzeichnen und zusätzlich den Parameter USELIKE=1 setzen. psw=[passwort] PHP-Beispiel: $url = " ELIKE=1&usr=ABC&psw=DEF"; $ch = curl_init($url); curl_setopt($ch, CURLOPT_MUTE, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE); echo $http_status; echo "<br>result:".htmlspecialchars($output); curl_close($ch); Löschen Per DELETE auf dialogue1 GmbH Seite 9 von 18

11 3.2 Listen Folgender Aufruf zeigt Informationen über eine Liste an. Der Parameter contacts bestimmt, ob Informationen über die Kontakte der entsprechenden Liste angezeigt werden sollen. Falls der Parameter nicht angegeben wird, werden ausschließlich Informationen über die Liste zurückgegeben. GET auf Anlegen Folgender PUT-Aufruf an erstellt eine Liste im Ordner lm9 mit der Bezeichnung Testliste und fügt entsprechende Kontakte dieser Liste hinzu. <list> </list> <folder id= lm9 /> <field name= LABEL >Testliste</label> <contacts> <contact id= lm9 />. </contacts> Falls ein Kontakt nicht existiert, wird dieser ignoriert. Sofern eine Liste mit der gleichen Bezeichnung im Ordner vorhanden ist, wird ein 409 Fehler ausgeben. Falls keine OrdnerID (=FolderID) übergeben wird, wird versucht, die Liste im Hauptordner anzulegen Bearbeiten Folgender POST-Aufruf an ändert Namen und Ordner-Zuordnung und fügt Kontakte hinzu: <list> dialogue1 GmbH Seite 10 von 18

12 </list> <folder id= lm9 /> <field name= LABEL >Bezeichnung</label> <contacts> <contact id= kllm9 > <contact id= glf49 > <contact id= lmd3 > <contact id= 7843 > </contacts> PHP-Beispiel: $url = " $xml_data = " <list> <contacts> <contact ID='kno607k80'></contact> <contact ID='kno6068nk'></contact> </contacts> </list>"; $ch = curl_init($url); // curl_setopt($ch, CURLOPT_MUTE, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_HTTPHEADER, array('content-type: text/xml')); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml_data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE); echo $http_status; echo "<br>result:".htmlspecialchars($output); curl_close($ch); Löschen Mit folgendem DELETE-Aufruf können wird eine Liste gelöscht: BITTE BEACHTEN: ENTHALTENE KONTAKTE BLEIBEN DAVON UNBERÜHRT!!! dialogue1 GmbH Seite 11 von 18

13 3.3 Ordner Im Gegensatz zu Kontakten und Listen sind Ordner hierarchisch strukturiert, d.h. Ordner können innerhalb von Ordnern liegen Anzeigen Folgender GET-Aufruf zeigt alle Listen und Ordner im Wurzelverzeichnis an und entspricht der Ansicht des Ordners Alle in amity: Eine mögliche Antwort kann lauten: <?xml version="1.0" encoding="utf-8"?> <reply> <data> <folder id='kmo7m' label='unterordner' /> <list id='lomlo' label='liste 1' /> <list id='loook' label='liste 2' /> <list id='lo777' label='liste 3' /> </data> </reply> Um nur den Inhalt eines spezifischen Ordners aufzulisten, ist folgender Aufruf auszuführen: Eine mögliche Antwort kann lauten: <?xml version="1.0" encoding="utf-8"?> <reply> <data> <list id='lomlo' label='liste 4 in Unterordner kmo7m' /> <list id='loook' label='liste 5 in Unterordner kmo7m' /> </data> </reply> Anlegen Mit folgendem PUT-Aufruf können Sie einen Ordner im bestehenden Ordner kmo7m anlegen: Der XML-Body: dialogue1 GmbH Seite 12 von 18

14 <folder> <field name= LABEL >Ordner unter kmo7m</field> </folder> Bearbeiten Mit folgendem POST-Aufruf an die Adresse können Sie den Ordner mit der ID kmo7m umbenennen: <folder> <field name= LABEL >Mein neuer Name</field> </folder> 3.4 Newsletter Anlegen einer neuen HTML-Vorlage Das Anlegen einer neuen Newsletter-Vorlage erfolgt per PUT die Asset-Ressource: Folgendes Beispiel legt eine HTML- an und verwendet dabei soagr die aus Amity bekannten Platzhalter zur persönlichen Anrede des Empfängers. Die Besonderheit an diesem API-Aufruf ist, dass der Quelltext der für eine korrekte Übertragung base64-enkodiert werden muss. Titel, Name und Bezeichnung werden UTF8-kodiert. Des Weiteren besteht die Möglichkeit, das Linktracking innerhalb von HTML- s zu aktivieren. Quellcodebeispiel $url = " $html_code = "<html><body><h1>eine kurze Überschrift</h1> <p>und ein kleiner Absatz mit wenig Text!</p> <p><br><br><a href=\" bin ein Link</a>!</p></body></html>"; // Zur Gewährleistung der fehlerfreien Übertragung wird der HTML-Code kodiert (Base64) $html_code_base64 = base64_encode($html_code); dialogue1 GmbH Seite 13 von 18

15 // Weitere essentielle UTF8-kodierte Angaben in temporären Variablen $tmp_name = utf8_encode("ein dialogue1 Testnewsletter per API"); $tmp_subject = utf8_encode("sübject mit Ü und Ö kein Problem"); $tmp_title = utf8_encode("(k)ein Titel"); $xml_data = " <newasset> <field name='name'>".$tmp_name."</field> <field name='subject'>".$tmp_subject."</field> <field name='title'>".$tmp_title."</field> <field name='htmlcode_base64'>".$html_code_base64."</field> <field name='plaintext_base64'>".$plaintext_base64."</field> <field name='linktracking'>on</field> </newasset>"; $chlead = curl_init(); curl_setopt($chlead, CURLOPT_URL, $url); curl_setopt($chlead, CURLOPT_USERAGENT, 'Dialogue1Connector/1.5'); curl_setopt($chlead, CURLOPT_HTTPHEADER, array('content-type: application/json','content-length: '. strlen($xml_data))); curl_setopt($chlead, CURLOPT_VERBOSE, 1); curl_setopt($chlead, CURLOPT_RETURNTRANSFER, true); curl_setopt($chlead, CURLOPT_CUSTOMREQUEST, "PUT"); curl_setopt($chlead, CURLOPT_POSTFIELDS,$xml_data); curl_setopt($chlead, CURLOPT_SSL_VERIFYPEER, 0); $chleadresult = curl_exec($chlead); $chleadapierr = curl_errno($chlead); $chleaderrmsg = curl_error($chlead); $http_status = curl_getinfo($chlead, CURLINFO_HTTP_CODE); curl_close($chlead); echo "<br>result:".htmlspecialchars($chleadresult); echo "<br>status:".$http_status; Bei einem erfolgreichem Aufruf wird die Amity-interne ID des erzeugten Newsletter ausgegeben; diese benötigen Sie zum Anstoßen eines Versandes per API (s. Kapitel 3.4.3) Anlegen einer neuen Multipart-Vorlage Dieses Beispiel erweitert das vorige lediglich um zwei Parameter: den PlainText Teil sowie den expliziten Parameter, dass es sich bei dieser Vorlage um eine MultiPart- handelt. Hier ist die Besonderheit, dass der Plaintext-Teil zunächst UTF8- und danach base64-kodiert wird. Quellcode Ergänzungen zum vorigen Beispiel $plaintext ="Hallo [NAME1]! Zunächst bin ich die Überschrift!\n". "\n". "Und ein kleiner Absatz mit wenig Text!\n". "Tschühüüüss!"; $utf8_plaintext = utf8_encode($plaintext); dialogue1 GmbH Seite 14 von 18

16 $plaintext_base64 = base64_encode($utf8_plaintext); $xml_data = "<newasset>... <field name='plaintext_base64'>".$plaintext_base64."</field> <field name='multipart'>yes</field>... </newasset>"; Versand anlegen Ein Versand kann per PUT an angelegt werden. Im XML-Teil werden folgende Parameter definiert: Die AssetID ist die ID des zu versendenden Newsletters Description steht für die Beschreibung Mit SCHEDULETYPE wird der Versandzeitpunkt festgelegt. Mögliche Werte sind: o IMMINENT = sofort o TODAY = heute o LATER = später Per DATE und TIME wird der Versandzeitpunkt festegelegt, dabei gilt: Bei der Wahl der Versandoption LATER müssen beide Felder DATE und TIME ausgefüllt werden, bei TODAY nur TIME und bei IMMINENT sind keine Zeitangaben nötig. Das Datum bitte immer im Format 05 und nicht 5 angeben. APPROVAL ermöglicht die sofortige Freigabe des Mailings Eine Versandkategorie wird per CATEGORY ausgewählt. Beispielcode: $url = " $description = utf8_encode('testüberschrift!'); $xml_data = " <newmailing> <field name='assetid'>1270</field> <field name='description'>".$description."</field> <field name='date'> </field> <field name='time'>16:36</field> <field name='scheduletype'>imminent</field> <field name='approval'>n</field> <field name='category'>81</field> dialogue1 GmbH Seite 15 von 18

17 <lists> <list id='m0k8n'></list> </lists> </newmailing>"; $chlead = curl_init(); curl_setopt($chlead, CURLOPT_URL, $url); curl_setopt($chlead, CURLOPT_USERAGENT, 'Dialogue1Connector/1.4'); curl_setopt($chlead, CURLOPT_HTTPHEADER, array('content-type: application/json','content-length: '. strlen($xml_data))); curl_setopt($chlead, CURLOPT_VERBOSE, 1); curl_setopt($chlead, CURLOPT_RETURNTRANSFER, true); curl_setopt($chlead, CURLOPT_CUSTOMREQUEST, "PUT"); curl_setopt($chlead, CURLOPT_POSTFIELDS,$xml_data); curl_setopt($chlead, CURLOPT_SSL_VERIFYPEER, 0); $chleadresult = curl_exec($chlead); $chleadapierr = curl_errno($chlead); $chleaderrmsg = curl_error($chlead); $http_status = curl_getinfo($chlead, CURLINFO_HTTP_CODE); curl_close($chlead); echo "<br>result:".htmlspecialchars($chleadresult); echo "<br>status:".$http_status; 3.5 Reporting Bouncer Der Zugriff auf Informationen zu Hard-/Softbouncern erfolgt per GET. Die folgenden Parameter können bei dem Aufruf benutzt und belibieg kombiniert werden: - Die ID des betreffenden Mailings MailingID - Die Angabe eines Monats DATE im Format Eine -Adresse oder sogar ein -Suchmuster für Quellcodebeispiele // Anzeigen der Bouncer des Mailings kknl6 $url = " DEF"; // Anzeigen aller Bouncer vom September 2012 $url = " "; dialogue1 GmbH Seite 16 von 18

18 // Anzeigen der Bouncer des Mailings kknl6 $url = " =1&usr=ABC&psw=DEF "; $ch = curl_init($url); curl_setopt($ch, CURLOPT_MUTE, 1); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $output = curl_exec($ch); $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE); echo $http_status; echo $output; curl_close($ch); 3.6 Zugriff auf sonstige Ressourcen Der Zugriff auf Ressourcen wie Dokumente, Templates, Benutzer und Mailings ist ebenfalls möglich. Weitere Informationen erhalten Sie gerne auf Anfrage. 4 Anmerkungen und Tipps - GET Anfragen können direkt im Browser aufgerufen werden, das Ergebnis versteckt sich hier jedoch manchmal im Seitenquellcode (im Browser Firefox per Tastenkombination STRG+U) - XML ist bekanntermaßen sehr anfällig. Achten Sie deshalb bitte immer auf eine korrekte Syntax und vor allem die Quotings, also ` etc. - Ebenfalls ist es wichtig, die unterschiedlichen Request-Methoden PUT/POST zu beachten! - Erhalten Sie als Ausgabe einen 500er Fehler, haben aber alle vorherigen Punkte beachtet? Dann fügen Sie bitte in Strukturblöcke, die lediglich eine einzelne Anweisung erhalten, ein <field name='forcemode'>on</field> oder auch <event name='forcemode'>on</event> in Ihren Aufruf ein. - Für die Auswertung von Rückgabewerten empfehlen wir Ihnen die frei verfügbare PHP- Funktion aus dem den Artikel Extracting attributes from XML elements ( - Im XML Code: Sonderzeichen bitte immer UTF8-Kodieren, ein Beispiel dazu liefert Kontakt anlegen in Kapitel Ebenfalls wichtig: Bei PUT-Befehlen die Größe des Requests angeben! (s. Beispiel 3.1.2) dialogue1 GmbH Seite 17 von 18

19 5 Abschlussbemerkung und Ausblick amity wird regelmäßig erweitert. Nicht alle Erweiterungen und Veränderungen können zeitnah in diesem Dokument abgebildet werden. Geplant sind folgende Entwicklungen: a) Authentifizierung-Erweiterung für noch mehr Sicherheit b) Ausbau des Reportings Differenzen (z.b. bei den Screenshots) sind somit möglich. Für Irrtümer wird keine Haftung übernommen. dialogue1 GmbH Seite 18 von 18