Zur Homepage www.HI-Tier.de REST-Service
Zurück Home Nach oben
Öffentlicher Bereich für Entwickler

 

Allgemein

Die Dienste von HI-Tier sind seit September 2014 auch über einfache Webdienste - sogenannte REST-Services (Representational State Transfer) - verfügbar. Die Kommunikation erfolgt ausschließlich über durch den Port 443. Als Transportprotokoll wird verschlüsseltes https verwendet. Die interne "Nutzlast" basiert weiterhin auf dem HIT-Protokoll.

REST wurde als einfache Alternative zu ähnlichen Verfahren wie SOAP und WSDL und dem verwandten RPC gewählt. Das Verfahren wird noch weiterentwickelt. Insbesondere ist geplant, vereinfachte Objekt-Strukturen an zu bieten. Die jetzt schon bestehenden Schnittstellen sind aber weitestgehend stabil. Neuerungen sollen (möglichst) abwärtskompatibel eingeführt werden.

Aufrufpunkte und Dokumentation

Aus Gründen der Redundanz und Verfügbarkeit gibt es jeweils verschiedene Server. Bei Wartungsarbeiten werden die DNS-Namen nichtverfügbarer Server auf andere System umgeleitet. Es ist daher kontraproduktiv auf Client-Seite IP-Adressen oder lang andauerndes DNS-Caching zu verwenden. Empfehlenswert ist, bei Nichterreichbarkeit eines Servers, automatisch von Seiten des Clients die alternative URL zu versuchen. Der Hauptserver (primary) und der Ersatz (backup) sind völlig identisch ausgestattet und können in beliebiger Reihenfolge benutzt werden.

Die Aufruf-Punkte "Service URL", insbesondere die Webservernamen können sich bis Ende 2014 noch ändern. Bitte beachten Sie entsprechende Hinweise dazu auf dieser Seite!

Testsystem

bulletPrimary: https://www3.hi-tier.de/hittest2
bulletBackup: https://www4.hi-tier.de/hittest2

Produktionssystem

bulletPrimary: https://www3.hi-tier.de/hitcom2
Backup: https://www4.hi-tier.de/hitcom2

Einführung in die Nutzung der HIT-Rest Schnittstellen (API)

Grundsätzlich dienen die HIT-Rest Schnittstellen als Transportmittel für das generische HIT-Protokoll. Es gibt die oben aufgeführten verschiedene Schnittstellen-Gruppen mit unterschiedlicher Zielsetzung und unterschiedlicher Nähe zum rohen HIT-Protokoll.

In der Regel sind die http Kommandos GET und POST, teilweise auch PUT und DELETE implementiert. Die Parameter beim GET sind "URL-encoded". Beim POST können die Formulardaten mittels content-type: application/x-www-form-urlencoded oder application/json übermittelt werden. Die Antwortdaten werden standardmäßig im JSON-Format ausgegeben, können aber mittels accept: application/xml auch im XLM-Format angefordert werden.

Weiterführende Dokumentation zu den einzelnen Schnittstellendefinitionen siehe hier unter

bulletProduktionsystem REST-API - Dokumentation der in Produktion befindlichen API
bulletTestsystem REST-API - ggf. neuere Funktionen, die erst im Test sind)

Clients

Diese REST-Services können sehr einfach über verschiedene Clienttechniken angesprochen werden.

bulletHitBatch Version 46 Stand 23.09.2014, kann alternativ über Port 80 mittels https kommunizieren und benötigt keine Freischaltung des proprietären HIT-Protokolls an Port 2222 / 2223.
bulletREST kann einfach über JavaScript aus Webseiten direkt angesprochen werden, Beispiele finden sich direkt auf den oben angegebenen Service-URLs. Einen sehr guten Einblick in die stattfindende  Kommunikation erhält man durch die Entwicklungs- und Debugfunktionen der Webbrowser

 


© 1999-2015 Bay.StMELF, verantwortlich für die Durchführung sind die Stellen der Länder , fachliche Leitung ZDB: Frau Dr. Kaja.Kokott@hi-tier.de, Technik: Helmut.Hartmann@hi-tier.de
Seite zuletzt bearbeitet: 29. September 2016 15:38, Anbieterinformation siehe hier im Impressum.