Inhaltsverzeichnis

    API-REST-Server starten

    Ihre Aufgabe/Ausgangslage

    Sie möchten den API-REST-Server starten, um eine Verbindung zu JTL-Wawi herzustellen. Sie können den API-REST-Sever entweder manuell selbst oder automatisch als Dienst starten. Beide Möglichkeiten sind in diesem Guide-Beitrag beschrieben.
    Hinweis: Die JTL-Wawi API ist aktuell in der Open-Beta-Phase. Bis zum offiziellen Release nutzen Sie die Schnittstelle im Rahmen des Pilotprogramms kostenfrei. Je nachdem, welche JTL-Edition/Paketkonfiguration Sie gebucht haben, steht Ihren JTL-Wawi API aber nach dem offiziellen Release möglicherweise nicht zur Verfügung. Die JTL-Editionen im Überblick.

    API-Anbindung manuell starten

    Wenn Sie den API-REST-Server manuell starten möchten, müssen Sie jedes Mal, wenn Sie Ihren Rechner hochfahren, die Kommandozeile aufrufen und die Eingaben vornehmen, um den API-REST-Server selbst zu starten.

    1. Öffnen Sie auf Ihrem PC über die Suchleiste die Kommandozeile (CMD) bzw. die Eingabeaufforderung mit Administratorrechten.
    2. Navigieren Sie zum Installationsverzeichnis von JTL-Software. In der Regel ist der Pfad C:Program Files (x86)JTL-Software. Verwenden Sie den Befehl cd, gefolgt von dem entsprechenden Pfad, um in das Programmverzeichnis zu wechseln.
    3. Geben Sie für die JTL-Wawi Version 1.8.7.1 den Befehl JTL-Wawi.Rest.exe inkl. den erforderlichen Parametern ein, um den API-Server zu starten.

    Beispiel: JTL.Wawi.Rest.exe –w ”Standard” –l 127.0.0.1 ––port 5883 –d eazybusiness

    Hinweis: Diese Parameter dienen als Beispiel. Passen Sie die Parameter entsprechend Ihren Anforderungen an.

    Standardparameter sind zum Beispiel:

    • w [Profilname]: Profilname (Standard: „Standard“)
    • l [IP-Adresse]: IP-Adresse, auf der der API-Server laufen soll (Standard: „127.0.0.1“)
    • -port [Port]: Portnummer für die API (Standard: „5883“)
    • d [Datenbank]: Name der Datenbank (Standard: „eazybusiness“)

    API-Anbindung als Dienst starten

    Wenn Sie den API-REST-Server als Dienst starten wird dieser jedes Mal, wenn Sie Ihren Rechner hochfahren, automatisch im Hintergrund gestartet, ohne, dass Sie Eingaben vornehmen müssen.

    Hinweis: Sie müssen mindestens JTL-Wawi Version 1.10 oder höher verwenden, um den API-REST-Server als Dienst starten zu können.
    1. Öffnen Sie auf Ihrem PC über die Suchleiste die Kommandozeile (CMD) bzw. die Eingabeaufforderung mit Administratorenrechten.
    2. Navigieren Sie zum Installationsverzeichnis von JTL-Software. In der Regel ist der Pfad C:Program Files (x86)JTL-Software. Verwenden Sie den Befehl cd, gefolgt von dem entsprechenden Pfad, um in das Programmverzeichnis zu wechseln.
    3. Geben Sie für die JTL-Wawi Version 1.10.0.0 den Befehl JTL-Wawi.Rest.exe install inkl. den erforderlichen Parametern ein, um den API-Server zu starten.

    Beispiel: JTL.Wawi.Rest.exe install –instancename „JTL-Wawi API“ -w „Standard“ -l 127.0.0.1 –port 5883 -d eazybusiness

    Standardparameter sind zum Beispiel:

    • install: Installiert den API-REST-Server als Dienst
    • uninstall: Deinstalliert den angegebenen Dienst
    • –instancename: Name des Dienstes

    API-Anbindung testen

    Nachdem Sie den API-Server gestartet haben, sehen Sie verschiedene URLs. Diese URLs führen zur lokalen Swagger-API-Dokumentation, in der Sie die Endpunkte testen können.

    Sie haben den API-REST-Server gestartet und können jetzt in JTL-Wawi eine App über die Schnittstelle registrieren. Lesen Sie mehr zum Thema hier: JTL-Wawi API nutzen.