SOAP API Schnittstellen

So individuell wie die Softwarelösungen, welche Ihr Unternehmen benötigt, müssen auch die dazu passenden Schnittstellen sein. Nur sie können beispielsweise anhand von Standard-Kommunikationsprotokollen für den reibungslosen Daten- und Nachrichtenaustausch sorgen. Dieser Beitrag informiert Sie darüber, worum es sich bei einer SOAP-API handelt, wie sie funktioniert, was sie von der REST-API unterscheidet und vieles mehr.

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 Nachricht aufgebaut, die eine SOAP-API übermittelt?

Services im Web und Client-Anwendungen empfangen XML-Dokumente in Form von SOAP-Nachrichten. Definiert werden diese durch das Simple Object Access Protocol und aufgebaut sind sie aus den folgenden Bestandteilen:

Envelope: Alle in der Nachricht befindlichen Daten werden zusammengefasst, womit er der Container für Header und Body ist. Der SOAP Envelope erkennt das XML-Dokument als SOAP-Nachricht.
Header: Hier sind Metainformationen über die SOAP-Nachricht gespeichert. Beispielsweise sind das Daten zur Authentifizierung, welche das empfangende System benötigt. Da keine zwingend notwendigen Punkte hinterlegt sind, ist der Header optional. Sofern vorhanden, ist er immer das erste Element im Umschlag und kommt nur einmal vor.
Body: In diesem Element sind die eigentlichen Informationen der via SOAP-API übermittelten Nachricht enthalten. Unabdingbar sind hier Aufruf- und Antwortinformationen. Der Webservice muss diese an die aufrufende Anwendung übertragen. Welche Struktur die Daten haben, hängt von den kommunizierenden Systemen ab.
Fehlermeldung: Sofern ein SOAP-Fehler entsteht, wird ein HTTP-500-Fehler angezeigt. Eine Meldung darüber besteht aus dem Code des Fehlers, einer Zeichenfolge, einem 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.

Durch die Anwendung im Webservice- oder SOA-Framework verbirgt die übergeordnete SOA-Schnittstelle oft die SOAP-API vor den Endnutzern. Das macht SOAP besonders geeignet für unternehmensweite Servicearchitekturen, bei denen verschiedene Anwendungen über standardisierte Protokolle kommunizieren.

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.

Aspekt	REST-API	SOAP-API
Fokus	Datenaustausch zwischen Nutzern und Apps	Nachrichtenaustausch online
Format	XML, Text, HTML, JSON	XML
Flexibilität	Ja	Nein
HTTP-Implementierung	Ja	Ja
Sicherheit	Ja	Ja (WS-Security)

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

Eine SOAP-API kann in Verbindung mit SAP-Softwarelösungen eingesetzt werden oder auch im Umfeld von Enterprise. Konkrete Einsatzgebiete zu benennen ist jedoch schwierig. In der Regel setzen Sie eine SOAP-API ein, wenn eine Anwendung nicht direkt auf eine Informationsquelle zugreifen soll oder darf – das kann unter anderem bei einer Datenbank der Fall sein. SOAP schafft einen guten und sicheren Weg, Informationen zwischen zwei Anwendungen auszutauschen. Eine SOAP-API findet sich in den Suchanzeigen von Amazon, eBay und Co. wieder, die eine Einbindung auf Partnerseiten aufweisen.

REST-API und SOAP-Schnittstelle kombinieren: Welche Möglichkeiten gibt es?

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.

SOAP-API für Ihr Unternehmen

Die passende Schnittstelle für Software zu finden ist nicht immer leicht. Jedes Unternehmen hat individuelle Anforderungen, wenn es um den Datenaustausch zwischen Softwaresystemen geht. Wir entwickeln Ihnen nicht nur die passende API entsprechend den Bedürfnissen Ihres Unternehmens, sondern implementieren diese auch – von der Analyse über die Entwicklung bis zum produktiven Betrieb.

Ob SOAP, REST oder eine Kombination: Als Spezialist für Schnittstellenentwicklung finden wir die optimale Softwarelösung für Ihre Integration. Unsere Digitalisierungsberatung hilft Ihnen dabei, die richtige Architektur zu wählen.