AllBytes Logo
SOAP API Schnittstellen
Schnittstellenentwicklung

SOAP API Schnittstellen

30. November 2022
4 Min. Lesezeit

Die passenden Schnittstellen sind genauso individuell erforderlich wie maßgeschneiderte Softwarelösungen. Sie ermöglichen durch Standard-Kommunikationsprotokolle einen fehlerfreien Austausch von Daten und Nachrichten.

Eine API – was ist das?

Das Akronym API steht für "Application Programming Interface" und bezeichnet eine Anwendungs- und Programmierschnittstelle. Eine API übernimmt die Vermittlung von Anfragen wie dem Versand von Nachrichten, damit das empfangende System diese versteht und verarbeitet. Die Kommunikation zwischen verschiedenen Systemen erfolgt über Codes.

Was ist eine SOAP-API?

Das "Simple Object Access Protocol" wird seit Version 1.2 durch die Abkürzung SOAP bezeichnet. Es handelt sich um ein Nachrichtenprotokoll, das es verteilten Anwendungselementen ermöglicht, über das Internet zu kommunizieren. SOAP fungiert als Zwischensprache, die Anwendungen verschiedener Programmiersprachen nutzen. Ein wesentlicher Vorteil liegt in der Unabhängigkeit von SOAP: Entwickler können sprachenunabhängige SOAP-APIs erstellen und projektspezifische Funktionen integrieren.

Wie ist eine SOAP-Nachricht aufgebaut?

Web-Services und Client-Anwendungen empfangen XML-Dokumente als SOAP-Nachrichten. Das Simple Object Access Protocol definiert folgende Komponenten:

  • Envelope: Fungiert als Container für Header und Body und fasst alle Nachrichtendaten zusammen
  • Header: Enthält Metainformationen, beispielsweise Authentifizierungsdaten; ist optional und kommt maximal einmal vor
  • Body: Beinhaltet die eigentlichen Informationen sowie Aufruf- und Antwortinformationen
  • Fehlermeldung: Bei SOAP-Fehlern wird ein HTTP-500-Fehler angezeigt mit Fehlercode, Zeichenfolge, Akteur und Details

Wie funktioniert SOAP?

Eine SOAP-API leitet SOAP-Nachrichten vom Sender zum Empfänger weiter. Der Übertragungsweg kann mehrere Stationen mit unterschiedlichen Rollen umfassen. SOAP-Knoten verarbeiten und beantworten Nachrichten oder signalisieren Fehler. Typischerweise fragt ein Client über HTTPS einen SOAP-Dienst bei einem Webserver an. Der Server leitet die Nachricht an einen SOAP-Anwendungsserver weiter, der diese prüft und ausführt.

Für die Nachrichtenverarbeitung sind erforderlich:

  • Informationen über Repräsentation und Datenkodierung
  • Semantische Daten
  • Richtlinien zum Einsatz von RPC-Mechanismen

Die Übertragung erfolgt im HTTPS- oder HTTP-Format.

SOAP- oder REST-API?

Bei der Schnittstellenentwicklung ergibt sich oft ein Vergleich zwischen REST und SOAP APIs. SOAP gehört zu Architekturmodellen und Protokollen für den Online-Nachrichtenaustausch zwischen Anwendungen. REST ist eine Web-Service-API mit Fokus auf Software-Architektur in verteilten Systemen.

REST bevorzugt HTTP und unterstützt mehrere Nachrichtenformate (XML, Text, HTML, JSON). SOAP beschränkt sich auf XML. REST punktet mit einfacher Implementierung und moderner Architektur, während SOAP durch integrierbare WS-Security stärker bei Sicherheit ist und sich für Online-Transaktionen eignet.

AspektREST-APISOAP-API
FokusDatenaustausch zwischen Nutzern und AppsNachrichtenaustausch online
FormatXML, Text, HTML, JSONXML
FlexibilitätJaNein
HTTP-ImplementierungJaJa
SicherheitJaJa (WS-Security)

Was können Sie mit der SOAP-API machen?

SOAP-APIs lassen sich mit SAP-Softwarelösungen oder im Enterprise-Umfeld einsetzen. Sie werden typischerweise verwendet, wenn eine Anwendung nicht direkt auf eine Informationsquelle wie eine Datenbank zugreifen soll oder darf. SOAP bietet einen sicheren Weg für den Informationsaustausch zwischen Anwendungen und findet sich beispielsweise in den Suchanzeigen von Amazon und eBay wieder.

REST-API und SOAP-Schnittstelle kombinieren

Eine Entscheidung zwischen SOAP und REST ist nicht zwingend erforderlich. Um sicherzustellen, dass beide APIs konsistent funktionieren, wird häufig eine REST-API für einen Service implementiert und die SOAP-API anschließend daraus generiert. Ein Gateway ermöglicht Zugriff auf den REST-Service, während ein Plugin bei SOAP-Anfragen eingesetzt wird. Die Nutzerdaten können in CSV oder Base64 statt XML übertragen werden, und SOAP-Nachrichten lassen sich verschlüsseln.

Ihr nächster Schritt

Bereit, das in Ihrem Unternehmen umzusetzen?

AllBytes begleitet mittelständische Unternehmen seit über 20 Jahren bei der Digitalisierung. Sprechen Sie direkt mit unseren Architekten — kostenlos und unverbindlich.

Erstgespräch anfragen