Product
Neue Events API, detailliertes E-Mail-Tracking und Suche
Wir freuen uns, die Veröffentlichung unserer neuesten API bekannt zu geben, die den Arbeitsalltag in der Entwicklung einfacher macht. Mit unserer vollständig überarbeiteten Events API lässt sich schnell und einfach ermitteln, was genau mit jeder einzelnen Ihrer E-Mails passiert ist. Ähnlich wie bei einer Tracking-Nummer von FedEx, mit der Sie den gesamten Versandweg verfolgen, behalten Sie mit unserer Events API jedes einzelne Ereignis rund um Ihre E-Mail im Blick – auch solche, die nach der Zustellung eintreten.
Wir haben zudem den Protokolle Tab in unserem Control Panel für die Nutzung der Events API aktualisiert, sodass Sie auch dort detailliertere Informationen sehen. Sie sehen nun auch Ereignisse, die nach der Zustellung der E-Mail eintreten, wie etwa Öffnungen und Klicks. Darüber hinaus können Sie detailliertere Suchen durchführen, beispielsweise nach allen Ereignissen zu einer bestimmten Nachricht, indem Sie nach der message-id suchen.
Diese detaillierten Logs stehen der Kundschaft von Mailgun ohne zusätzliche Kosten zur Verfügung. Die Kundschaft mit einem kostenlosen Testkonto erhält eine Ereignisspeicherung von mindestens zwei Tagen, während Konten mit einem kostenpflichtigen Tarif mindestens 30 Tage erhalten.
Kommen wir nun zu den Details, warum uns die neue API so begeistert:
Leistungsstark
Da über Mailgun monatlich regelmäßig Millionen von E-Mails versendet werden, kann die Suche nach dem Status einer bestimmten E-Mail wie die Suche nach der Nadel im Heuhaufen sein. Um dies zu erleichtern, haben wir eine Reihe von Filterparametern hinzugefügt. Sie können diese Filter zudem kombinieren, um komplexe Abfragen zu erstellen. Wir haben außerdem die Methode für das Polling der API verbessert. Bisher verfügte unsere Events API nur über einfache Skip- und Limit-Parameter, um festzulegen, welche Teile der Logs abgerufen werden sollen. Dies war umständlich und führte zu einer schlechten Leistung. Mit der neuen Events API stellen wir Parameter bereit, mit denen Sie neben einer aufsteigenden oder absteigenden Sortierung auch einen bestimmten Zeitraum festlegen können. Wir geben in der Antwort auch URLs für den Abruf der nächsten und vorherigen Seiten zurück. So können Sie problemlos durch die Logdaten navigieren, ganz gleich, wie viele Datensätze zurückgegeben werden. Wenn das Enddatum des Zeitraums nicht angegeben ist und die Navigation aufsteigend erfolgt (zeitlich vorwärts), erhalten Sie schließlich eine leere Seite (d. h. das Ende des Datensatzes). Sie können dieselbe URL zu einem späteren Zeitpunkt verwenden. Das Ergebnis enthält dann die Log-Einträge, die seit der vorherigen Anfrage geschrieben wurden.
Performant
Wir haben die API so konzipiert, dass sie selbst bei zig Millionen Log-Einträgen äußerst performant ist. Dafür basiert die API auf ElasticSearch, einem Open-Source-Framework für die Erstellung von Echtzeit-Suchen und -Analysen. Wir werden noch einen weiteren Beitrag zu den architektonischen Details veröffentlichen.
Nachfolgend finden Sie die Parameter und einige Beispiele für die Nutzung der API.
API-Parameter
Filterfeld-Parameter
Durch die Kombination von Parametern lassen sich komplexe Abfragen erstellen:
Hier sind einige Beispiele: Der Betreff lautet „Nur noch ein Tag zum Sparen!“ UND Empfänger ist „customer@example.com“ ODER „paul@example.com“
curl -s --user api:key-3ax6xnjp29jd6fds4gc373sgvjxteol0 -G rnhttps://api.mailgun.net/v2/samples.mailgun.org/events rn --data-urlencode "subject"="Only one day left to save!" rn --data-urlencode "recipient"="customer@example.com OR paul@example.com"rn
Nachrichtengröße ist größer als 25 MB UND Anhangname ist „design-final.pdf“ (Hinweis: Die Nachrichtengröße wird in Bytes angegeben)
curl -s --user api:key-3ax6xnjp29jd6fds4gc373sgvjxteol0 -G rnhttps://api.mailgun.net/v2/samples.mailgun.org/events rn --data-urlencode "attachment"="design-final.pdf"rn --data-urlencode "size"=">26214400"rn
Alle Ereignisse im Blick
Bisher haben wir nur Informationen zu Ihrer E-Mail protokolliert, bis sie vom empfangenden E-Mail-Server akzeptiert oder verworfen wurde. Mit der Events API können Sie alle Ereignisse abfragen, einschließlich derer, die nach der Zustellung der E-Mail eintreten. Die vollständige Liste der Ereignisse finden Sie unten:
Wann kommt die Events API zum Einsatz?
Um unsere Events-Webhooks zu ersetzen oder zu erweitern
Wenn Ihre Frage in etwa lautet: „Was ist mit meiner E-Mail passiert?“, bot Mailgun schon immer eine einfache Möglichkeit, dies zu beantworten: Webhooks. Sie haben einfach einen Webhook für die Art von Ereignis konfiguriert, die Sie interessierte (z. B. zugestellt, geöffnet, geklickt usw.), und auf Ereignisse gewartet. Jedes Mal, wenn es eine E-Mail gibt, lösen wir einen Webhook aus. Dies setzt jedoch voraus, dass Sie auf Ihrer Seite eine Menge Daten speichern. Auch wenn wir die meisten fehlgeschlagenen Webhooks erneut versuchen, können längere Ausfälle in Ihrem System zu Datenverlusten führen. Wenn Sie viele E-Mails versenden, bedeutet dies letztlich auch viele Zugriffe auf Ihre Endpunkte, was Ihren Server überlasten kann.
Unsere neue Logs API beantwortet die Frage, was mit Ihrer E-Mail passiert ist, mithilfe einer Pull-Methode (Polling der Events API) im Gegensatz zur Push-Methode von Webhooks.
Den Status für eine bestimmte E-Mail bereitstellen
Ein großer Teil unserer Kundschaft nutzt E-Mails für zeitkritische Benachrichtigungen. Wir haben bereits in unserem Blog darüber berichtet, wie das Produkt Cloud Monitoring von Rackspace Mailgun nutzt, um die Kundschaft zu benachrichtigen, wenn es Probleme mit ihrer Website oder App gibt. PagerDuty genannt, und Exceptional Error Tracking sind weitere bekannte Beispiele aus unserer Kundschaft, bei denen E-Mail-Zustellung und die Möglichkeit, diese Zustellung zu tracken, geschäftskritisch ist. In diesen Fällen hört man von den Endnutzenden nicht selten: „Ich habe die E-Mail nicht erhalten.“ Nun können Sie in der Events API einfach nach der message-ID suchen und erhalten den Status für jede Nachricht. Wir teilen Ihnen eindeutig mit, ob die Nachricht zugestellt wurde. Diesen Status können Sie Ihrem Kunden bei Bedarf zur Verfügung stellen oder ihn sogar in Ihre eigene Benutzeroberfläche integrieren. Kein Rätselraten mehr. Nur noch handfeste Daten.
Das ist die Events API auf den Punkt gebracht. Weitere Informationen finden Sie in der vollständigen Dokumentation.
Viel Erfolg beim Versand.
Ihr Mailgun-Team
