Das Emarsys API bietet programmatischen Zugriff auf die meisten Funktionen der Emarsys Marketingplattform, dient Ihnen als Integrationsschnittstelle und ermöglicht die Automatisierung Ihrer Marketingkampagnen.
- Mittels Integration können Sie auf die meisten Funktionalitäten der Emarsys Plattform direkt aus Ihrer eigenen Applikation zugreifen.
- Mittels Automation können Sie komplexe Marketingkampagnen einrichten, die ganz ohne menschliche Interaktion aufseiten Ihres Unternehmens durchgeführt werden.
Über den Emarsys Developer Hub
Hier in diesem Hilfeportal finden Sie eine Liste aller öffentlichen API-Endpunkte; der Großteil unseres technischen Contents ist jedoch über das Developer Hub abrufbar.
Diese Ressource bietet Anleitungen, Ressourcen, Anwendungsbeispiele und interaktive Referenzen, mit deren Hilfe Sie sich mit der Emarsys Marketingplattform integrieren können, um persönliche Kundeninteraktionen über E-Mail, Mobile, Social Media, SMS und Web zu ermöglichen.
Bereit loszulegen? Hier geht's zum Emarsys Developer Hub.
Bevor Sie beginnen
Um Ihnen Zeit zu sparen und Ihnen zu helfen, die häufigsten Fehler zu vermeiden, haben wir eine Reihe von wichtigen Schritten und übergeordneten Konzepten gesammelt, die Sie kennen sollten, bevor Sie mit der Verwendung des Emarsys API beginnen.
Keine Angst, in ein paar Minuten machen Sie Ihren ersten erfolgreichen API Call. Zuerst sollten Sie sich aber noch überzeugen, dass folgende Vorkehrungen getroffen wurden:
- Ihr Unternehmen hat die relevanten Abschnitte des Onboarding-Vorgangs bereits absolviert: das Daten-Onboarding und die Aktivierung der Channels, die Sie verwenden werden.
- Sie haben den Abschnitt Bevor Sie beginnen gelesen und sich mit der Arbeitsweise und den Möglichkeiten unseres RESTful API vertraut gemacht.
- Ihr Account Owner hat unter Management > Security Settings einen API-Benutzer sowie den entsprechenden Secret Key eingerichtet. Details finden Sie unter API-Benutzer.
Bevor Sie das API verwenden, empfehlen wir dringend, die folgenden Anleitungen zu lesen und sich so über Konzepte, Architektur und Best Practices zu informieren.
- Grundlagen kennenlernen - Informieren Sie sich über die grundlegenden Konzepte vom Emarsys und das Design unseres RESTful API, einschließlich Authentifizierung, Ratenlimitierung und Request-Strukturen.
- Erste Schritte machen - Folgen Sie unserer Anleitung, die Sie im Nu einsatzbereit macht.
Nachdem Sie die ersten Schritte absolviert haben, gehen Sie zur Endpoint-Referenz, um die verfügbaren Endpoints in Echtzeit mit ihren eigenen Daten zu sehen und zu testen. Im Developer Hub bieten wir zudem auch Code-Beispiele, eine umfangreiche Postman-Sammlung sowie Spezifizierungen für OpenAPI- und RAML-Formate.
Ressourcen
Endpoint-Spezifizierungen und -Definitionen erhalten Sie direkt im Developer Hub.
Sämtliche Endpoint-Spezifizierungen werden in den Formaten OpenAPI 2.0 und RAML 0.8 angeboten; dazu gibt es eine Postman-Sammlung im Developer Hub.
| Abschnitt | Inhalt |
|---|---|
| Bevor Sie beginnen | Lernen Sie die grundlegenden Emarsys Konzepte und das Design unseres RESTful API kennen. |
| Erste Schritte | Folgen Sie unserer Schritt-für-Schritt-Anleitung, wenn Ihnen die Plattform neu ist. |
| Endpoints | Sehen Sie sich die verfügbaren Endpoints an und testen Sie diese gleich vor Ort mit Ihren eigenen Daten. |
| Personalisierung |
|
| Response-Codes |
|
| Glossar |
|
| Anhang |
|
| Changelog | Zeigen Sie Release Notes an und verfolgen Sie die Änderungen bezüglich Emarsys API und Developer Hub. |
Interaktive Demo-Optionen
Vor dem Codieren kommt das Experimentieren! Um Sie beim Einrichten Ihrer Integration zu unterstützen, bieten wir verschiedene Optionen für das Testen Ihrer Implementierung.
Emarsys Developer Hub
Direkt im Developer Hub können Sie jeden Endpoint mit Ihren eigenen Daten testen.
Dabei sollten Sie vorsichtig vorgehen, die Funktionalität ist keine Sandbox! Alle Änderungen in Bezug auf Kontakt- oder Kampagnendaten haben reale Auswirkungen auf Ihren Account; wenn Sie also zum Beispiel Delete a Contact testen, wird der Kontakt, mit dem Sie testen, tatsächlich gelöscht.
- Wählen Sie den Endpoint aus, den Sie testen wollen.
- Klicken Sie Try it out.
- Geben Sie Ihre Authentifizierungsinformationen in der Navigationsleiste ein.
- Geben Sie die erforderlichen Parameter an.
- Klicken Sie Send request.
Ihr Request wird an unsere Server gesendet und gibt echte Daten zurück.
Auch Code-Beispiele und Spezifizierungen stehen für Sie bereit. Gehen Sie zum Tab Code Generation auf der Endpoint-Seite, um für jeden Endpoint produktionsbereite Code-Beispiele in vielen verschiedenen Sprachen abzurufen. Mittels Copy & Paste können Sie diese in Ihren eigenen Code einfügen.
Auch Curl-Befehle sind in den Code-Beispielen verfügbar.
Postman-Sammlung
Wenn Sie lieber mit Postman arbeiten, laden Sie unsere kategorisierten Libraries herunter; diese enthalten sämtliche Endpunkte mit Beispielen.
Bei Verwendung von Postman müssen Sie den WSSE Header Value selbst berechnen und im Header X-WSSE manuell einfügen.
Die API Demo-Seite
Wir bieten eine Demo-Seite, auf der Sie mit den Möglichkeiten, die das API bietet, experimentieren können. Die Seite hat eine grafische Benutzeroberfläche, die Ihnen das Experimentieren mit API Requests und deren Parametern erleichtert. Die Responses werden angezeigt, damit die Benutzer sehen, was sie erwartet.
- Um auf die Demo-Umgebung zurückzugreifen, gehen Sie zu https://api.emarsys.net/api-demo.
- Um zu überprüfen, ob die Zugriffsdaten gültig sind, machen Sie einen Test-Request; Sie sehen dann, welche Sprachen verfügbar sind. Dafür gehen Sie zum Tab Contact Fields. Lassen Sie das Feld Language code leer und klicken Sie OK. Der Response erscheint rechts auf derselben Seite, einschließlich einiger Informationen zum Request. Die folgende Tabelle zeigt die möglichen Responses und Fehlerursachen.
| Response (replyCode, replyText) | Mögliche Ursache | Lösungsvorschlag |
|---|---|---|
| 0, OK | Sie waren erfolgreich und Ihre Credentials wurden akzeptiert. | Sie sollten sich die Sprachenliste ansehen. |
| 1, Unauthorized | Mit Ihren Credentials stimmt etwas nicht. | Überprüfen Sie Ihre Zugangsinformationen. |
| Keinerlei Response |
|
|
Der Response zu Ihrem Request wird immer rechts oben auf der Seite angezeigt. Denken Sie nach dem Senden eines Requests daran, dass Sie möglicherweise nach oben scrollen müssen, um den Response zu sehen.
