Schnellsuche:ebay ameise worker paypal
Inhaltsverzeichnis

    Instanz der JTL-Wawi API über Kommandozeile (CMD) starten

    Ihre Aufgabe/Ausgangslage

    Sie möchten eine Instanz des REST-API-Servers über die Kommandozeile/Windows-Konsole starten, um eine Verbindung zu JTL-Wawi herzustellen. Sie können den REST-API-Sever entweder manuell selbst oder automatisch als Dienst starten. Beide Möglichkeiten werden in diesem Guide-Beitrag beschrieben.

    Andere Ausgangslagen

    Voraussetzungen/Einschränkungen

    • Sie haben Erfahrung im Umgang mit API-Servern und Kommandozeilenbefehlen.
    Hinweis: Die JTL-Wawi API befindet sich derzeit 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 Ihnen 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 REST-API-Server manuell über die Kommandozeile starten möchten, rufen Sie jedes Mal, wenn Sie Ihren Rechner hochfahren, die Kommandozeile auf und nehmen die Eingaben vor, um den REST-API-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. Diese Parameter sind:
    • -w [Profilname]: Profilname (Standard: „Standard“)
    • -l [IP-Adresse]: IP-Adresse, über die der Server erreichbar sein soll (Standard: „0.0.0.0“)
    • – – port [Port]: Portnummer für die API (Standard: „5883“)
    • -d [Datenbank]: Name der Datenbank (Standard: „eazybusiness“)

    Mit den Standardparametern sieht der Befehl in der Kommandozeile wie folgt aus:

    JTL.Wawi.Rest.exe -w "Standard" -l 0.0.0.0 --port 5883 -d eazybusiness
    Hinweis: Wenn die Anwendung in der Windows-Konsole unerwartet anhält, ist die Ursache häufig der Editiermodus (QuickEdit-Modus). Dieser Modus wird zum Beispiel durch einen Mausklick ins Konsolenfenster aktiviert. Deaktivieren Sie den Modus in den Konsoleneigenschaften oder führen Sie die REST-API als Windows-Dienst aus, um Unterbrechungen zu vermeiden.

    Exkurs zu IP-Adresse und Port

    Die oben gezeigten Parameter dienen als Beispiel. Wählen Sie je nach Anwendungsfall und Sicherheitsbedarf andere Parameter für l/IP-Adresse und port:

    • 127.0.0.1: Localhost; ermöglicht nur lokale Zugriffe auf demselben Rechner
    • 192.168.x.x: Lokale IP-Adresse; ermöglicht Zugriff innerhalb des lokalen Netzwerks
    • 0.0.0.0: Alle Schnittstellen; ermöglicht den Zugriff auf alle verfügbaren Schnittstellen – lokal, im Netzwerk und, wenn freigegeben, extern

    Damit die API aus dem Internet erreichbar ist, müssen Sie im Router eine Weiterleitung für den genutzten Port einrichten (Port Forwarding). Je nachdem, wie Ihr Netzwerk konfiguriert ist, müssen Sie gegebenenfalls eine öffentliche IP-Adresse oder DynDNS verwenden.

    API-Anbindung als Dienst starten

    Wenn Sie den REST-API-Server als Windows-Dienst einrichten, wird der REST-API-Server automatisch im Hintergrund gestartet, wenn Sie Ihren Rechner hochfahren. Der Server steht also direkt nach dem Systemstart bereit, um Anfragen zu verarbeiten.

    Hinweis: Sie benötigen mindestens JTL-Wawi 1.9, um den REST-API-Server über die Kommandozeile als Windows-Dienst starten zu können. Ab JTL-Wawi 1.10 können Sie auch JTL-Administrator nutzen, um den Windows-Dienst einzurichten. Siehe Instanz der JTL-Wawi API mit automatischem Start in JTL-Administrator einrichten
    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 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 0.0.0.0 --port 5883 -d eazybusiness

    Standardparameter sind zum Beispiel:

    • install: Installiert den REST-API-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 REST-API-Server über die Kommandozeile (CMD) gestartet.

    Wie geht es weiter?

    Registrieren Sie in JTL-Wawi eine App über die Schnittstelle. Siehe Anwendung über JTL-Wawi API anbinden