Wenn man in einem Eingabefeld die F1-Taste drückt, öffnet sich eine separate Hilfeseite mit Erläuterungen zum entsprechenden Eingabefeld bzw. zur Eingabeseite. Ob diese Hilfeseite in einem searaten Fenster geöffnet wird oder im aktuellen kann im Benutzer- und Programm-Profil festgelegt werden.

REST-Schnittstellen für Programme

Hinweis: Die API-Schnittstellen sind ständig in Weiterentwicklungen aber stabil und können produktiv benutzt werden! Änderungen werden in der Regel als Erweiterungen implementiert. Abwärtskompatiblilität - also, dass bestehende Aufrufe unverändert weiter funktionieren wird angesteht, kann aber nicht verbindlich zugesichert werde. Die Nutzung der Schnittstellen ist nur in einem für die jeweilige Nutzergruppe üblichen Form und Umfang zulässig. Bei missbräuchlicher Nutzung behalten wir uns vor bestimmte Funktionen oder Nutzer zu sperren. Ein Rechtsanspriuch auf Nutzung und Verfügbarkeit besteht nicht.
Wenn Sie sich unsicher sind, ob die geplante Nutzung zulässig ist, kontaktieren Sie und bitte unter hit@hi-tier.de.

Diese Seite wendet sich an Softwarehersteller, die HIT per REST-Service nutzen wollen.

  • Dokumentation und Testinterfaces gemäß OpenAPI Specifization hier unter Swagger
  • Definitionen der einzelnen Schnittstellen nach altem (eingeschränkten) Dokumentationsformat hier unter apiHelp
  • REST-Demo-Client als frei verfügbares C#-Projekt in GitHub, hier unter HitRestClient
REST Version 2

Version 3.2.20240611

Seit April 2019 steht die neue Version unserer REST-Schnittstellen bereit.

Es grundsätzlich zwei Arten von Funktionen

  1. Funktionen, die ohne Anmeldung benutzt werden können, z.B.
    • Prüfen einer Ohrmarke oder Betriebsnummer auf syntaktische Korrektheit
    • Umwandeln einer beliebig formatierten Ohrmarke oder Betriebsnummer in die numerische bzw. alphanumerische normierte Darstellungsform
    • Abfrage des DataDictionary, welches die Beschreibung der in der ZD verfügbaren Meldungen/Entitäten mit deren Spalten samt deren Strukturbeschreibungen enthält
  2. Funktionen, die nur mit Anmeldung benutzt werden können, z.B.
    • Einfügen mittels PUT, abfragen mittels GET, ändern mittels POST, stornieren mittels DELETE gemäß CRUD-Pattern im "Standard REST-Modell"
    • Einfügen, abfragen, ändern, stornieren mittels HIT-Abfragesyntax, aber strukturieren Daten

... mehr

REST Version 1

Version 1.18, Stand 27.09.2024 18:00

Seit 2014 existiert die "alte" Version unserer REST-Schnittstellen. Grundsätzlich dienen diese Schnittstellen als Transportmittel und Kapselung für das generische HIT-Protokoll, in verschiedenen Ausprägungen für unterschiedliche Anwendungsszenarien angepasst.

Es gibt drei Komplexitätsstufen:
• Höheres Level → HitCom
• Level, welches den HitBatch "nachahmt" → HitBatch
• Niedriges Level, d.h. auf Protokollebene → HitRaw

und eine Demo-Schnittstelle:
• Demo mit einfachen Beispielen → HitDemo

Einführung

Es gibt die oben aufgeführten verschiedenen Schnittstellen-Gruppen mit unterschiedlicher Zielsetzung und unterschiedlicher Nähe zum rohen HIT-Protokoll.

In der Regel sind die HTTP-Verben GET und POST implementiert, teilweise auch PUT und DELETE. Die Parameter beim GET sind gemäß HTTP-Spezifikation URL-encoded. Beim POST müssen die Formulardaten mittels HTTP-Header content-type: application/x-www-form-urlencoded oder content-type: application/json übermittelt werden. Die Antwortdaten werden standardmäßig im JSON-Format geliefert, können aber mittels HTTP-Header Accept: application/xml auch im XML-Format angefordert werden.