Dokumentation der SOAP Schnittstelle
Die otela Enterprise Systems stellt Webservices für Kooperationspartner bereit. Diese Schnittstellen nutzen die SOAP-Technologie.
Im Vergleich zu RESTFUL-APIs, die den Programmierern freie Gestaltungsmöglichkeiten beim Aufbau der Schnittstellen geben,
ist eine SOAP-Schnittstelle standardisiert und basiert auf dem Ausstausch von XML-Nachrichten über das HTTP-Protokoll.
Darüber hinaus lassen sich die online bereit gestellten Dienste absichern(Verwendung von API-Keys, Credentials), so dass dieser
Webservice "by Design" einer geschlossenen Gruppe zugänglich gemacht wird. Buchungsdaten, die in der Paxcloud erfasst werden,
müssen sicher über das Internet übertragen und Kooperationspartnern zur Verfügung gestellt werden.
Aus diesem Grund wurde die SOAP-Technologie gewählt, da diese seit Jahren im Einsatz ist, alle gängigen Entwicklungsumgebungen in der Lage sind,
WSDL-Dateien zu parsen und es so ein verlässliches Datenprotokoll gibt.
Vorraussetzungen an die Kooperationspartner
- Die einzige Vorraussetzung an die Firewall der beteiligten Unternehmen ist ein offener TCP Port 80/443
- Eine Entwicklungsumgebung, IDE, die mit einer WSDL, einer (W)eb-(S)ervice-(D)escription-(L)anguage, umgehen kann.
- Ein Programmierer, der mit der gewählten IDE umgehen kann und mindestens eine höhere Programmiersprache beherrscht.
IDE
Programmiersprachen
Da SOAP ein Datenaustauschprotokoll auf XML-Basis ist, lassen sich die hier im Haus programmierten Schnittstellen mit einer XML-Bibliothek für die jeweilige Programmiersprache verwenden, die in der Lage ist, SOAP-basierte Nachrichten zu verarbeiten.
Für die meisten gängigen Programmiersprachen gibt es fertige Bibliotheken, die den Umgang mit WSDL/SOAP erleichtern.
Beispiele dafür sind C#, Visual Basic, C/C++, Java und PHP.
Zur Erleicherung der Arbeit des Programmierers ist es empfehlenswert, SOAP-UI zu installieren und sich damit anzuschauen, wie eine SOAP-Request/Response Nachricht aufgebaut ist.