Entwicklerportal

Einführung

Esendex macht unsere APIs zugänglich und das Senden und Empfangen von Nachrichten einfach. Auf dieser Seite geben wir Ihnen eine kurze Einführung in unsere APIs. Weitere Informationen finden Sie im Entwicklerportal.

Im folgenden Video erhalten Sie einen Überblick über das Entwicklerportal.

Video

Was ist eine API?

Eine API (Application Programming Interface) verbindet Ihre Anwendung mit anderen Diensten oder Datenquellen. Bei einem API-Aufruf fordern Sie Daten an, die API ruft diese ab und sendet Ihnen anschließend eine Antwort. Dazu verwenden Sie einfach eine HTTP-Methode für Ihre Anfrage.

Stellen Sie sich vor, Sie bestellen Essen im Restaurant. Sie teilen dem Kellner Ihre Bestellung mit, er leitet sie an den Koch weiter, und der Kellner bringt Ihnen anschließend Ihr Essen. Ein API-Aufruf funktioniert genauso.

APIs erfüllen zwei Hauptzwecke:

• Regeldefinition: APIs erklären die Interaktion mit dem Server. Sie legen die Regeln für Entwickler fest.
• Datenübertragung: Sie übertragen Daten effizient zwischen Ihrer Anwendung und dem Server. Dadurch wird sichergestellt, dass Sie die benötigten Daten erhalten.

API-Endpunkt

Ein API-Endpunkt ist eine spezifische URL, über die Sie auf eine Ressource auf dem Server zugreifen können. Er dient als Kommunikationsschnittstelle zwischen einem API-Client und einem API-Server, über die Anfragen eingehen und Antworten ausgegeben werden.

Jeder Endpunkt besteht aus:

• Einer Endpunkt-URL
  • Base URL -this remains fixed e.g. https://conversations.esendex.co.uk
  • the endpoint path – this is where you can add configurable parameters which affect the response, acting as filters for your search
• Einer HTTP-Methode
• Headern
• Einem Body

REST-API

Unsere APIs nutzen eine REST-Architektur (Representational State Transfer), auch bekannt als RESTful-API. Das bedeutet, sie funktionieren online. Wenn Sie eine Anfrage an eine REST-API senden, erhalten Sie alle verfügbaren Daten.

Kurzanleitung

Bevor Sie beginnen, sollten Sie folgende API-Begriffe kennen:

Begriff	Definition
API-Schlüssel	Ein eindeutiger Zugangscode aus Buchstaben und Zahlen, der Zugriff auf eine API gewährt.
Endpunkt	Der digitale Ort/Pfad, an dem eine API Anfragen zu ihren Ressourcen empfängt.
Anfragemethode	Verwendet HTTP-Methoden (GET, POST, PUT, DELETE), um der API mitzuteilen, was sie tun soll.
API-Aufruf	Der Prozess, bei dem ein Client (Ihr Computer) eine API-Anfrage an einen Server sendet.
Statuscode	Ein Zahlencode, der im Antworttext einer API erscheint und angibt, ob Ihre Anfrage erfolgreich war oder nicht.
API-Server	Authentifiziert und verarbeitet API-Anfragen, bevor er eine entsprechende Antwort liefert.
API-Antwort	Eine vom API-Server generierte und an den Client (Ihren Computer) zurückgesendete Antwort.

Wenn Sie mehr über APIs erfahren möchten, besuchen Sie bitte unser Entwicklerportal.