Einführung
Ziel des Workbooks
Das Workbook befindet sich derzeit im Aufbau. Im Laufe der Zeit werden nach und nach weitere Inhalte ergänzt. Das bisherige Workbook und die technische Dokumentation unserer Webservice-Schnittstelle kannst du hier herunterladen.
Dieser Leitfaden zeigt die alles was du wissen musst, um die MAILINGWORK API nutzen zu können. Anders als eine reine technische Dokumentation, konzentriert sich dieses Workbook auf typische Anwendungsfälle, praktische Beispiele und Best Practices,
die dir den Einstieg erleichtern – egal, ob du zum ersten Mal mit
unserer API arbeitest oder bestehende Prozesse automatisieren möchtest.
Du lernst Schritt für Schritt:
- wie du auf unsere API zugreifst und sie testest,
- wie du Kontakte und Verteiler verwaltest,
- und wie du Automatisierungen und Webhooks einsetzt, um E-Mail-Marketing noch effektiver zu gestalten.
Für wen ist dieses Workbook gedacht?
- Entwickler:innen, die unsere API in eigene Anwendungen integrieren möchten,
- Marketing-Teams mit technischer Affinität, die Automatisierungen aufbauen wollen,
- Agenturen oder Dienstleister, die mehrere Mandanten oder Kunden betreuen,
- und grundsätzlich alle, die E-Mail-Marketing über eine Schnittstelle effizient steuern wollen.
Voraussetzungen
Account
Um die API nutzen zu können, benötigst du einen MAILINGWORK-Account. Du hast noch keinen Account? Dann melde dich bei vertrieb@mailingwork.de oder über unser Kontaktformular.
API-Modul
Dein Account benötigt die Berechtigung zur Nutzung des API-Moduls. Dieses ist in den Tarifen Automation und Enterprise enthalten. Du bist Dir unsicher ob Du das Modul hast? Logge dich in Deinen Account ein und prüfe, ob Du das Menü Module > Schnittstellen > Webservicedemo (API) sehen kannst. Falls nicht, melde dich bei uns.
Falls du ein Multi-Account System mit den Tarifen Automation oder Enterprise hast, kannst du das Recht für die Nutzung der API an Deinen Unteraccounts selbst hinterlegen.
API-Benutzer und Authentifizierung
Im gewünschten Account muss ein Benutzer vorhanden sein, dem eine Rolle mit der Berechtigung ‚Webservice (API, Zapier)‘ zugewiesen ist. Die Verwaltung der Benutzerrollen findest Du im Menü Administration > Benutzerrollen.
Wir empfehlen, für die API-Nutzung einen separaten Benutzer anzulegen um diesen von den regulären Benutzern der Oberfläche abzugrenzen. Du findest die Benutzerverwaltung im Menü Adminstration > Benutzer.
Die Authentifizierung an der API erfolgt über Benutzername und Passwort. Da Benutzernamen in MAILINGWORK eindeutig sind, wird darüber der zugehörige Account identifiziert.
Grundlegende Programmierkentnisse
Du kannst die API-Requests in der Programmiersprache deiner Wahl ausführen. Über die MAILINGWORK-Oberfläche kannst du dir Beispiele aller Calls in PHP ausgeben lassen.
Der erste API-Call
Du kannst sämtliche Funktionen der API über die MAILINGWORK-Oberfläche ausprobieren. Logge dich dazu in Deinen Account ein und gehe zu: Module > Schnittstellen > Webservicedemo (API).
Die in der Webservice-Demo ausgeführten Aufrufe werden produktiv im ausgeführt. Passe also auf, wenn du Daten veränderst.
- Wähle das Protokoll im Dropdown Servertyp. MAILINGWORK unterstützt SOAP in den Versionen 3 und 4 sowie HTTP, jeweils mit JSON oder XML-Rückgabe.
- Wähle im Dropdown Funktion den Eintrag GetAccountId. Diese Funktion gibt dir die ID Deines MAILINGWORK-Accounts aus.
- Gib Benutzername und Passwort Deines API-Benutzes an.
- Durch Klick auf "Senden" wird der Call ausgelöst.
Im Abschnitt Beispielcode sieht Du den PHP-Quellcode des Calls, unter Ergebnis die Resultate.