Einführung

In diesem Wiki finden Sie Informationen zur Nutzung eines API-Zugangs an den Servern des Schallöhr-Verlags.

Voraussetzungen

Zum Verständnis

Diese Informationen wenden sich an Webentwickler und Software-Entwickler, welche die Funktionalität unserer Web-Dienste in Ihre Software, ihre eigenen Web-Dienste oder Webseiten integrieren wollen.

Zum Verständnis der hier vermittelten Informationen setzen wir somit Erfahrung in Softwareentwicklung und Internettechnologie voraus. Der Leser sollte mit folgenden Technologien und Hintergründen vertraut sein:

Nötig:

  • Auszeichnungssprachen HTML, bzw. XML,
  • Syntax von JSON (JavaScript Object Notation),
  • der Sprache JavaScript,
  • dem Umgang mit HTTP-Aufrufen (POST, GET).

Hilfreich:

  • Kenntnisse in Node.js, Serverseitige Technologie zur Verwendung von JavaScript,
  • Programmierung in Java,
  • Objektorientierung.

Zum Ausprobieren

Um den grundsätzlichen Umgang mit einer SCHALLÖHR VERLAG API zu erproben bieten wir Ihnen einen zeitlich befristeten, kostenlosen Demo-Zugang. Um diesen zu erhalten gehen Sie bitte wie folgt vor:

  1. Registrieren Sie sich im SCHALLÖHR VERLAG Portal um ein Nutzerkonto zu erhalten.
  2. Bitte kontaktieren Sie uns per Telefon unter 08151 / 28798 oder schreiben uns eine E-Mail an info@schalloehr-verlag.de und wir senden Ihnen einen Demo Voucher-Code zu.
  3. Lösen Sie den damit verbundenen Voucher-Code in der Lizenz-Verwaltung Ihres Nutzerkontos ein.
  4. Es erscheint eine Produkt-Kachel auf dem Desktop Ihres Nutzerportals.
  5. Öffnen Sie Verwaltungsbereich Ihrer Demo-Lizenz durch Klick auf die Produkt-Kachel.
  6. Entnehmen Sie dort die Informationen zur Demofunktion und den Lizenznamen Ihres Demovertrags.
  7. Verwenden Sie den Lizenznamen1) und Ihr Passwort2) um den Zugang zu nutzen.

Zur Nutzung

Um die Funktionen der API des SCHALLÖHR VERLAGs in ihre Software zu integrieren, bietet Ihnen einen der SCHALLÖHR VERLAG zahlreiche vorgefertigte Produktkonfigurationen, die sich inhaltlich und in ihrer Tarifstruktur unterscheiden. Sie können sich jederzeit zu den Tarifen und den technischen Anbindungsmöglichkeiten beraten lassen. Falls Sie keine geeigneten Inhalte und Tarife finden, stellen wir ihnen gerne individuelle Konfigurationen zusammen. Falls Sie bereits eine Lizenz erworben haben, gehen Sie bitte ebenso vor, wie es für die API-Demo beschrieben wurde:

  1. Registrieren Sie sich im SCHALLÖHR VERLAG-Portal um ein Nutzerkonto zu erhalten.
  2. Halten sie den Voucher-Code bereit, der mit dem Erwerb der Lizenz zugesandt wurde.
  3. Lösen Sie den damit verbundenen Voucher-Code in der Lizenz-Verwaltung Ihres Nutzerkontos ein.
  4. Es erscheint eine Produkt-Kachel auf dem Desktop Ihres Nutzerportals.
  5. Öffnen Sie Verwaltungsbereich Ihrer Demo-Lizenz durch Klick auf die Produkt-Kachel.
  6. Entnehmen Sie dort die Informationen zur Demofunktion und den Lizenznamen Ihres Vertrags.
  7. Verwenden Sie den Lizenznamen3) und Ihr Passwort4) um den Zugang zu nutzen.



Funktionsprinzip

Sie können den API-Zugriff zu den Schallöhr-Verlags-Rechenkernen auf unterschiedliche Weise in unterschiedlichen Produkttypen einsetzen. Zur Veranschaulichung präsentieren wir ihnen zwei Möglichkeiten. Einerseits die Integration in eine moderne Website, ein Webportal oder eine Webapplikation. Andererseits die Nutzung aus einer klassischen Installationssoftware-Lösung, die jedoch das Vorhandensein einer Internetverbindung voraussetzt5).

Webapplikationen

Allgemeines

In der modernen Webapplikation, auf einer Website oder einem Kundenportal stellen sie ihre Oberflächen meist durch einen Webbrowser zur Verfügung. In den Meisten Fällen bedeutet dies eine Kombination von HTML- und JavaScript-Technologie. Jedoch sind sie natürlich in der Wahl ihrer Mittel völlig unabhängig.

Ansprache der API

Der Web-Service der Schallöhr-Verlags-API wird durch eine REST-ähnliche Schnittstelle angesprochen, die auf dem HTTP-Protokoll basiert und technologie-unabhängig ist. Ein Aufruf erfolgt durch einen HTTP-POST-Request. Die Daten der Anfrage werden in einem JSON-kodierten Datenelement mitgeliefert. Die Antwort auf jede Anfrage enthält die Daten ebenso im JSON-Format.

Präsentation der Ergebnisse

Die Präsentation der Ergebnisse eines solchen Berechnungsaufrufes obliegt wieder ihrer Webapplikation. Sie sind damit in der Verwendung ihrer graphischen Hilfsmittel und des Designs völlig unabhängig.

Ablauf

Der schematische Ablauf einer durch einen Endkunden durchgeführten Berechnung kann wie folgt beispielhaft wiedergegeben werden:

  1. Abruf des Eingabeformulars vom Webserver des Kunden.
  2. Geführte Eingabe der zu berechnenden Werte durch den Endkunden in das Web-Formular.
  3. Kurz vor dem Start der Berechnung wird der Vorgang im Hintergrund durch einen Login autorisiert, ein Kurzzeit-Sitzungsschlüssel erworben und an die Web-Applikation übermittelt.6)
  4. Die Berechnung wird, samt ihrer Berechnungsdaten, dem Rechenbefehl und dem Kurzzeit-Sitzungsschlüssel an die API des Schallöhr-Verlags-Webservice gesendet.
  5. Die Anfrage wird geprüft, der Quota des Kunden zugerechnet und ausgeführt.
  6. Das Ergebnis wird an die Web-Applikation auf dem Client des Endkunden zurückgegeben.
  7. Die Web-Applikation des Kunden stellt die Ergebnisse der Berechnung auf dem Client des Endkunden dar.

Klassisches Software-Produkt

Allgemeines

Auch in der klassischen Softwareinstallation müssen sie nicht auf die Funktionen der Schallöhr-Verlags-Rechenkerne verzichten. Auch hier sind sie natürlich in der Wahl ihrer Mittel wie Programmiersprachen und Technologie-Plattformen völlig unabhängig.

Ansprache der API

Die REST-ähnliche Schnittstelle wird hier aus der auf dem PC des Endkunden installierten Software heraus angesprochen. Ein Aufruf erfolgt auch hier durch einen HTTP-POST-Request. Die Daten der Anfrage werden in einem JSON-kodierten Datenelement mitgeliefert. Die Antwort auf jede Anfrage enthält die Daten ebenso im JSON-Format.

Zur unmittelbaren Durchführung der Berechnung ist jedoch eine Internetverbindung nötig. Um Offline-Fähigkeit zu erreichen können Berechnungen beispielsweise vorab durchgeführt und gespeichert werden.

Präsentation der Ergebnisse

Die Präsentation der Ergebnisse eines solchen Berechnungsaufrufes obliegt wieder ihrer Software.

Ablauf

Der schematische Ablauf einer durch einen Endkunden durchgeführten Berechnung kann wie folgt beispielhaft wiedergegeben werden:

  1. Eingabe der zu berechnenden Werte durch den Endkunden in ihre Software.
  2. Kurz vor dem Start der Berechnung wird der Vorgang im Hintergrund durch einen Login auf ihrem Autorisierungs und Authentifizierungs-Server autorisiert. Auch hier wird ein Kurzzeit-Sitzungsschlüssel erworben. 7)
  3. Die Berechnung wird, samt ihrer Berechnungsdaten, dem Rechenbefehl und dem Kurzzeit-Sitzungsschlüssel an die API des Schallöhr-Verlags-Webservice gesendet.
  4. Die Anfrage wird geprüft, der Quota des Kunden zugerechnet und ausgeführt.
  5. Das Ergebnis wird an die Installation auf dem Client des Endkunden zurückgegeben.
  6. Die Software des Kunden stellt die Ergebnisse der Berechnung auf dem PC des Endkunden dar.





1)
Beispielsweise: Licence_ApiDemoStandardUserBasic_5528
2) , 4)
Das Passwort, welches Sie zur Anmeldung im Portal verwenden.
3)
Beispielsweise: Licence_RentGRVStandardUserBasic_5529
5)
Implementierung einer Offline-Fähigkeit durch geeignetes Caching durch sie ist natürlich jederzeit möglich.
6)
Wir empfehlen dringend diese Autorisierung und die zuvor nötige Authentifizierung nicht im Client (Webbrowser des Endkunden) durchzuführen, damit nicht Vertragsname und Passwort preisgegeben werden müssen.
7)
Wir empfehlen dringend diese Autorisierung und die zuvor nötige Authentifizierung nicht im Client (Beim Endkunden installierte Software) durchzuführen, damit nicht Vertragsname und Passwort preisgegeben werden müssen. Ebenso wäre durch dieses Vorgehen ein Austausch des Passwortes, falls nötig, mit großem technischem Aufwand verbunden. Ebenso können sie dann auf ihrem Authentifizierungsserver mit der Anfrage das Lizenz-Management für ihre Produkte verbinden.