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?

API bedeutet aufgelöst Application Programming Interface, und ist der Begriff für eine Anwendungs- und Programmierschnittstelle. Die API vermittelt Anliegen, wie etwa das Versenden von Nachrichten so, dass das empfangende System diese versteht und verarbeiten kann. Die Kommunikation zwischen mehreren Systemen ist gegeben. Diese erfolgt über Codes.

Was ist eine SOAP-API?

Das Simple Object Access Protocol ist seit der Version 1.2 eher unter der Abkürzung SOAP bekannt. Dabei handelt es sich um ein Nachrichtenprotokoll, durch welches verstreute Anwendungselemente über das Internet miteinander kommunizieren. SOAP ist demnach eine Zwischensprache, deren sich Anwendungen bedienen, wenn sie auf unterschiedlichen Programmiersprachen basieren.

Durch die Anwendung im Webservice- oder SOA-Framework, verbirgt die übergeordnete SOA-Schnittstelle oft die SOAP-API. Ein Vorteil ist die Unabhängigkeit von SOAP. So schreiben Entwickler verschiedensprachige SOAP-APIs und fügen für das jeweilige Projekt benötigte Funktionen und Eigenschaften hinzu.

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. Beispielweise 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 brauchen Sie, damit eine SOAP-Nachricht von einem Sender zum entsprechenden SOAP-Empfänger geleitet werden kann. Der Weg dazwischen kann verschiedene Stationen erhalten, die bestimmte Rollen übernehmen. SOAP-Knoten müssen Nachrichten, welche durch die API transportiert werden, verarbeiten und beantworten oder gegebenenfalls auf einen vorliegenden Fehler aufmerksam machen.

Grundlegend fragt ein Client über HTTPS einen SOAP-Dienst bei einem Webserver an. Dieser Server übergibt die Nachricht an einen SOAP-Anwendungsserver, welcher dann die Ausführung übernimmt. Auch hier erfolgt eine Prüfung aller Elemente der Nachricht, wird etwas nicht verstanden, dann erfolgt eine Fehlermeldung.

Für die Verarbeitung der Nachricht nach der Übermittlung über die SOAP-API werden diese Aspekte dringend gebraucht:

• Informationen über Repräsentation und Kodierung von Daten
• Daten zur Semantik
• Anhaltspunkte zum Einsatz von RPC-Mechanismen (falls eingesetzt)

Die Anfragen für SOAP-Dienste und die Antworten darauf werden im HTTPS-Format (Hypertext Transfer Protocol Secure) oder im HTTP-Format übertragen.

SOAP- oder REST-API?

Bei der Schnittstellenentwicklung ergibt sich je nach Projekt der Vergleich REST- vs SOAP-API, um heraus zu finden, welche Option verwendet werden sollte.

SOAP gehört zu einer Reihe von Architekturmodellen und Protokollen, die entwickelt wurden, um Anwendungen den Austausch von Nachrichten online zu ermöglichen. REST ist dabei eine Web-Service-API mit Fokus auf die Architektur von Software in verteilten Systemen. Wichtig ist sie zum Beispiel auch für die Kommunikation mobiler Geräte und Co.

Was die Übermittlung angeht, ist HTTP der bevorzugte Weg. Anders als bei einer SOAP-API gibt es aber noch mehrere Nachrichtenformate, neben XML sind das: Text, HTML und JSON.

REST punktet mit der unkomplizierten Möglichkeit zur Implementierung sowie moderner Architektur und Schlankheit. SOAP liegt bei der Sicherheit vorne, da sich WS-Security integrieren lässt. Im Rahmen eines serviceorientierten Frameworks verbindet es Webservices, das SOA-Framework und Anwendungskomponenten. Die SOAP-API eignet sich aufgrund der Starrheit und der Protokollsteuerung beispielsweise für Online-Transaktionen.

 

REST- vs SOAP-API im Überblick:

 

	REST-API	SOAP-API
Fokus	Daten zwischen Nutzern und Apps (verschiedenen Systemen) senden	Austausch von Online-Nachrichten
Nachrichtenformat	XML, einfacher Text, HTML, JSON	XML
Flexibilität	✓	Χ
Implementierung auf HTTP	✓	✓
Sicherheit	✓	✓ (WS-Security)

 

SOAP-API für Ihr Unternehmen

Die passende Schnittstelle für Software zu finden ist nicht immer leicht, vor allem, wenn es sich um eine Softwarelösung handelt, die ganz speziell nach den Bedürfnissen Ihres Unternehmens entwickelt wurde.

Wir entwickeln Ihnen nicht nur die passende API, wobei wir nach einer Prüfung und Tests zwischen den APIs für SOAP und REST unterscheiden, sondern implementieren diese auch. Unsere Experten stehen Ihnen hier stets mit ihrem Fachwissen zur Verfügung.

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.

Welche Möglichkeiten existieren, wenn neben einer REST-API auch eine SOAP-Schnittstelle zur Verfügung stehen soll?

Obwohl der Test darauf, ob sich als API SOAP oder REST besser für Ihre Zwecke eignet, meist zur Entscheidung für eine der beiden Optionen führt, muss es nicht immer SOAP vs REST heißen. Um zu verhindern, dass beide APIs verschiedene Verhaltensweisen an den Tag legen, werden sie nicht getrennt implementiert, sondern aufgrund der häufigen Verwendung wird eine REST-API für einen Service implementiert und die SOAP-API anschließend aus dieser generiert.

Ein Gateway ermöglicht bei entsprechender Anfrage Zugriff auf den REST-Service, während ein Plugin zum Einsatz kommt, sobald eine SOAP-Anfrage kommt. Diese Übertragung betreffend, kann für die Nutzerdaten innerhalb der Nachricht von XML abgewichen werden, denn CSV oder Base64 sind ebenso denkbar. Natürlich können SOAP-Nachrichten auch verschlüsselt übertragen werden.

Weitere Leistungen von Allbytes

Bei uns finden Sie nicht nur Experten im Bereich der Schnittstellenentwicklung, unser Leistungsspektrum ist sehr breit gefächert. Zu diesem gehört sowohl die Entwicklung einer für Ihre Zwecke passenden Datenbank, als auch die Arbeit mit dem WordPress-CMS und Shopware. Mit unserer Erfahrung als APP-Agentur kreieren wir Ihre Web Apps.. Im Rahmen unserer Digitalisierungsberatung finden wir mit Ihnen gemeinsam heraus, an welchen Stellen und mit welchen individuellen Lösungen wir Sie und Ihr Unternehmen am besten unterstützen. Weitere Informationen zu den einzelnen Leistungsbereichen finden Sie auf unserer Website.