Ihr Leitfaden zu API-Endpunkten

APIs können schwer zu verstehen sein, besonders wenn Sie nicht mit der Erstellung programmatischer Prozesse vertraut sind. Dürfen wir Ihnen ein kleines Geheimnis verraten? APIs sind lediglich Kommunikationswege für Anwendungen untereinander. Wenn Sie wissen, wie man sie nutzt, können sie Ihr Leben vereinfachen.

Wenn die Welt der E-Mail-APIs oder APIs im Allgemeinen neu für Sie ist, können API-Endpunkte anfangs schwer zu fassen sein. Ein API-Endpunkt ist lediglich eine eindeutige URL, die den Namen eines Servers oder Dienstes enthält. Er identifiziert einen bestimmten Ort innerhalb einer Application Programming Interface (API).

Um einen API-Endpunkt zu nutzen, müssen Sie einen API-Aufruf oder eine Anfrage (Request) durchführen. Wir haben eine kurze Analogie vorbereitet, um zu zeigen, wie diese Endpunkte funktionieren und wie nützlich sie sein können. Aber Vorsicht: Sie könnte Sie hungrig machen.

Um APIs zu beschreiben, stellt man sich am besten eine Bedienung in einem Restaurant vor. Sie geben Ihre Bestellung an die Bedienung weiter (wir denken da an einen leckeren Burrito). Diese leitet Ihre Bestellung an die Küche weiter und bringt Ihnen anschließend Ihr Essen. In dieser Analogie ist die Speisekarte die API-Dokumentation, die die angebotenen Speisen und Getränke des Restaurants beschreibt – und diese Menüoptionen sind unsere API-Endpunkte.

Das eigentliche Restaurant, das Sie betreten, ist wie die REST-API. Eine REST-API (oder RESTful-API) ist schlichtweg eine API, die einer spezifischen Architektur einer Webanwendung oder eines Dienstes entsprechen muss, damit Sie erfolgreich mit dieser Anwendung interagieren können. Mit anderen Worten: Sie können in diesem Restaurant köstliche Burritos bestellen, jedoch kein chinesisches Essen, da die Küche nicht auf Kung Pao Hühnchen ausgelegt ist.

Um eine „Bestellung aufzugeben“, führt das Entwicklungsteam einen API-Aufruf (oder eine API-Anfrage) durch, der eine Anwendung anweist, etwas zu tun. Die Anwendung wiederum nutzt eine API, um einen Webserver aufzufordern, etwas zu erledigen. Es gibt verschiedene Arten von API-Methoden, die Sie mit Ihrer Anfrage senden können. Diese bestimmen die Art der Daten, die Sie bearbeiten:

• GET: ruft eine Ressource ab
• PATCH: aktualisiert eine Ressource
• PUT: ersetzt eine Ressource
• POST: erstellt eine Ressource
• DELETE: entfernt eine Ressource

Jetzt haben wir Hunger, aber wir haben auch eine grundlegende Vorstellung davon, was APIs sind und wie sie funktionieren. Lassen Sie uns also darüber sprechen, welche Rolle Endpunkte dabei spielen.

Endpunkte sehen aus wie jede andere URL, an deren Ende ein Wort oder ein Bezeichner hinzugefügt wurde: /endpoint.

Der Endpunkt ist das, was wir essen möchten. Unsere Bestellung wird zwar von der Bedienung überbracht und vom Küchenpersonal zubereitet, aber wir entscheiden, welche Informationen gesendet werden. Da sie in letzter Zeit häufig in den Nachrichten waren, nehmen wir die Twitter-API als Beispiel.

Wir möchten einen neuen Tweet von der Twitter-API anfordern und können dies über deren /statuses/update-Endpunkt tun.

Der Endpunkt ist der Ort, an dem sich die API mit dem Backend-System von Twitter verbindet. Wenn wir eine Anfrage an den /statuses/update-Endpunkt senden, verarbeitet der Endpunkt die Anfrage (er teilt der Küche mit, was wir wollen und wie es zubereitet werden soll – in diesem Fall mit benutzerdefiniertem Text) und sendet eine Antwort zurück. Mit APIs können Sie programmatisch mit Websites und Diensten interagieren.

Es mag schwierig sein, den Nutzen von API-Endpunkten zu erkennen, wenn Sie nur einen einzigen Tweet erstellen. Stellen Sie sich jedoch ein Szenario vor, in dem Sie für Ihre Kundschaft Tweets verfassen, die in festgelegten Abständen veröffentlicht werden müssen. Mit der Twitter-API können Sie dies einrichten und das Marketing für Ihre Kundschaft effizient gestalten.

Nahezu alle SaaS- und CPaaS-Lösungen bieten ihrer Kundschaft eine REST-API, damit das Entwicklungsteam das Produkt in die eigenen Softwareanwendungen integrieren kann. Um auf diese APIs zuzugreifen, müssen Sie Kunde dieses Unternehmens sein. Oft nutzen Unternehmen eine Ratenbegrenzung (Rate Limiting), um eine faire Nutzung ihrer API sicherzustellen. Zudem gibt es OpenAPIs. Dabei handelt es sich um öffentliche APIs, auf die alle Entwicklungsfachleute zugreifen können.

Immer wenn Sie Daten über das Internet austauschen oder anfordern, müssen Sie auf Monitoring und Sicherheit achten. Die erste Ebene der API-Sicherheit ist ein API-Schlüssel. API-Schlüssel werden von der Anwendung oder dem Projekt generiert, die oder das den Aufruf ausführt. Sie können die Nutzung auf eine bestimmte Umgebung oder IP-Adressregion beschränken.

Da Endpunkte die eigentliche Schwerstarbeit leisten, ist es wichtig, dass sie sicher bleiben. Andernfalls könnte sich jede Person programmatisch Zugriff verschaffen und Ihre Daten ändern. Die gute Nachricht ist, dass Sie Endpunkte mit denselben bewährten Methoden absichern, die Sie wahrscheinlich bereits zum Schutz Ihrer anderen Online-Systeme verwenden.

Zu diesen Methoden gehören:

1. Basis-Authentifizierung/2FA
2. Verschlüsselung
3. OAuth 2.0

Beim Schutz Ihrer APIs und Entwicklungsumgebungen gelten grundlegende Sicherheits-Best-Practices. Wenn Sie nach Ihren Mailgun-Schlüsseln und -Anmeldedaten suchen, finden Sie diese hier.

Da es sich bei Endpunkten um URLs handelt, können – und sollten – Sie diese überwachen, um sicherzustellen, dass sie online bleiben. Wenn es um Online-Dienste und Websites geht, hören Sie oft den Begriff „Uptime“ (Betriebszeit). Dies ist der prozentuale Anteil der Zeit, in der Ihre Anwendung online bleibt – mit anderen Worten, der Prozentsatz der Zeit, in der Ihre App zugänglich ist und funktioniert. Ausfälle und Leistungsfehler verringern Ihren Gesamtprozentsatz.

Das Monitoring Ihrer Endpunkte liefert Ihnen zudem Metriken darüber, auf welche Endpunkte zugegriffen wird und welche Arten von API-Aufrufen das Entwicklungsteam durchführt. Dies hilft Ihnen dabei, das Nutzungsverhalten zu verfolgen und Einblicke in stark frequentierte Endpunkte zu gewinnen, um Ihre Leistung aufrechtzuerhalten.

Als E-Mail-Service-Provider (ESP) konzentriert sich der API-Support von Mailgun voll und ganz auf programmatische Lösungen, die Ihr E-Mail-Programm skalierbar, effizienter und erfolgreicher machen. Unser E-Mail-API ist eine spezielle Art von API, mit der Sie Ihre Web-App oder Plattform an einen ESP anbinden können, um dessen Funktionen in Ihrer eigenen Anwendung zu nutzen.

Wie das geht, fragen Sie sich? Der vielseitigste Anwendungsfall ist der Versand von Transaktions- oder Trigger-E-Mails. Sie können unsere API nutzen, um automatische E-Mails wie Kontobestätigungen, das Zurücksetzen von Passwörtern oder Erinnerungen an abgebrochene Warenkörbe einzurichten.

Dies sind einige unserer am häufigsten genutzten API-Endpunkte und deren Funktionen:

API-Endpunkte eignen sich ideal für einen großen Versandbedarf. Diese Kommunikationspunkte erleichtern die Einrichtung von programmatischen Skripten zur Optimierung Ihres E-Mail-Programms – von der Konfiguration automatisierter Nachrichten oder des Transaktions-Messagings bis hin zum Abruf von Metriken und Daten.

Wenn Sie häufig und in großem Umfang E-Mails versenden und keine E-Mail-API nutzen, schöpft Ihr E-Mail-Programm sein volles Potenzial nicht aus. Die Verwaltung verschiedener E-Mail-Arten und Transaktions-Trigger, der Erhalt wichtiger Ereignisbenachrichtigungen sowie der Abruf von Metriken sind wesentliche Faktoren für Ihr Wachstum – und APIs erleichtern all diese Prozesse.

Möchten Sie mehr Inhalte dieser Art? Das trifft sich gut, denn wir schreiben sehr gerne darüber. Abonnieren Sie unseren Newsletter und tauchen Sie mit uns tief in alle Themen rund um E-Mails ein.

Autor: Em Blitstein Em Blitstein is a Sr. Content Marketing Manager at Sinch Mailgun. She manages the Mailgun Blog, curates top-notch content, and falls down SEO rabbit holes. She writes about all things email and loves a good dev deep dive.