|
|
|
REST Version 2NutzungsvereinbarungDie REST-API der HI-Tier steht kostenlos und frei zur Verfügung. Es entstehen damit keine zusätzlichen Kosten. Für die legitimierte Nutzung setzen wir eine Registrierung voraus. Senden Sie uns daher die unterschriebene und ausgefüllte Nutzungsvereinbarung an technik @ hi-tier.de zurück. Die damit verbundene Erfassung von Daten haben wir in unserer Datenschutzerklärung spezifiziert. Allgemeine Hinweise
Einführung in die Nutzung der Schnittstellen (API) HIT-REST v2An den Endpunkten (REST-URL) der Version 2 ist sowohl die alte API des REST Version 1 (Details unten) als auch die neue API Version 2 verfügbar. Die neue API Version 2 gliedert sich grundsätzlich in zwei Arten von Funktionen
Weiterführende Dokumentation der APIs HitCom, HitBatch und HitRaw:
BesonderheitenWir weisen ausdrücklich darauf hin, sich mit den Informationen auf den nachfolgenden Seiten vertraut zu machen. Im Gegensatz zu klassischem, zustandslosen REST stellen wir einen Cache zur Verfügung, der die Anmeldeinformationen vorhält. Die Nutzung erhöht die Performance eklatant. Grundsätzlich dienen die REST-Schnittstellen von HIT/ZID als Transportmittel für das generische HIT-Protokoll, was bei größeren Abfragen zu dramatischen Performance-Unterschieden führt (z.B. Abfrage größerer Bestände). In der Regel sind die HTTP Verben
Allgemeines zu den EndpunktenAus Gründen der Redundanz und Verfügbarkeit gibt es jeweils verschiedene Server. Bei Wartungsarbeiten werden die DNS-Namen nicht-verfü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 eine alternative URL zu versuchen. Die verschiedenen Server sind völlig identisch ausgestattet und können in beliebiger Reihenfolge benutzt werden. Für die verschiedenen Systeme ("Testsystem", "Produktionssystem",
"Wartungssystem", und "Clonesystem") gibt es jeweils eine gemeinsame
URL / Webadresse unter Hinter
der Webadresse Basis-URLs der Endpunkte der verschiedenen Systeme REST v2Testsystem
Produktionssystem
Wartungssystem
Clonesystem
Allgemein - REST Version 1 (alt)
Allgemeines zu den EndpunktenAnalog oben bei REST v2. Endpunkte der verschiedenen Systeme REST v1Testsystem
Produktionssystem
Wartungssystem
Clonesystem
Einführung in die Nutzung der Schnittstellen (API) HIT-REST v1Grundsätzlich dienen die REST-Schnittstellen von HIT/ZID 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 Verben Weiterführende Dokumentation zu den einzelnen Schnittstellendefinitionen siehe Data Dictionary.
ClientsDiese REST-Services können sehr einfach über verschiedene Clienttechniken angesprochen werden.
|
|
|