Schnellsuche:ebay ameise worker paypal
Inhaltsverzeichnis

    Instanz der JTL-Wawi API mit automatischem Start in JTL-Administrator einrichten

    Ihre Aufgabe/Ausgangslage

    Sie möchten eine Instanz der JTL-Wawi API einrichten, um eine Verbindung zu JTL-Wawi herzustellen. Diese Instanz möchten Sie als Windows-Dienst einrichten. Die Instanz startet dann automatisch im Hintergrund, sobald Sie Ihren Rechner einschalten.

    Andere Ausgangslagen

    Voraussetzungen/Einschränkungen

    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.

    Informationen zum Einrichten einer Instanz von JTL-Wawi API

    Eine Instanz der JTL-Wawi API ist eine konkrete, betriebsbereite Verbindung zur JTL-Wawi, mit der ein externes System (z. B. Onlineshop, Middleware, Marktplatz oder eigene Software) automatisiert auf Wawi-Daten zugreifen kann – also Artikel, Bestellungen, Kunden, Lagerdaten etc.

    Mit einer API-Instanz verbinden Sie JTL-Wawi mit externen Systemen und tauschen so automatisiert Daten mit diesen Systemen aus. Über die REST-API können zum Beispiel Artikel, Aufträge, Kunden oder Lagerbestände automatisch abgerufen, aktualisiert oder erstellt werden.

    Eine eigene Instanz stellt dabei sicher, dass alle Verbindungsparameter wie Schnittstelle, Port und Zertifikat individuell konfiguriert und abgesichert sind.

    Sie möchten die Instanz als Windows-Dienst einrichten. Den Windows-Dienst können Sie entweder mit oder ohne eigenes Benutzerkonto verwenden:

    • Ohne eigenes Benutzerkonto: Standardmäßig wird der Dienst mit einem internen Windows-Benutzer eingerichtet. Es ist keine Benutzeranmeldung erforderlich. Der Dienst startet automatisch im Hintergrund mit dem Betriebssystem.
    • Mit eigenem Benutzerkonto: Sie hinterlegen die Zugangsdaten für ein Windows-Konto. Wenn der Windows-Dienst die API-Instanz gestartet hat, geben Sie den Benutzernamen und das Passwort dieses Windows-Kontos ein. Erst dann ist die API-Instanz einsatzbereit.

    Neue Instanz von JTL-Wawi API erstellen

    Instanzen für JTL-Wawi API richten Sie über das Tool JTL-Administrator ein. So gehen Sie vor:

    1. Öffnen Sie das Startmenü von Windows, indem Sie auf das Startsymbol klicken oder auf die Windows-Taste auf Ihrer Tastatur.
    2. Geben Sie in das Suchfeld JTL-Administrator ein.
    3. Öffnen Sie die App JTL-Administrator.
    1. Klicken Sie im neuen Dialogfenster JTL-Administrator auf die Schaltfläche Anlegen und wählen Sie im ausgeklappten Dropdown-Menü die Option Wawi-App.
    2. Sie sehen das neue Dialogfenster JTL-Wawi API einrichten. Geben Sie in das Feld Instanzname einen Namen für die neue Instanz ein. Der Instanzname ist frei wählbar und hilft Ihnen dabei, die Instanz später in der Liste des Dialogfensters JTL-Administrator zu identifizieren.
    3. Wählen Sie aus dem Dropdown-Menü Profil ein Profil. Das Standardprofil ist Standard.
    4. Wählen Sie aus dem Dropdown-Menü Mandant den Mandanten, für den die REST-API aktiviert werden soll. Bei Standardinstallationen mit nur einem Mandanten ist der Standardmandant eB-Standard vorausgewählt.
    5. Wählen Sie im Dropdown-Menü Schnittstelle die IP-Adresse, auf der der API-Server Anfragen entgegennehmen soll.
    • 127.0.0.1: Nur Programme auf demselben Rechner können auf die API zugreifen.
    • Lokale IP-Adresse des Rechners (zum Beispiel 192.168.0.5): Die API ist im lokalen Netzwerk erreichbar.
    • 0.0.0.0: Der Server lauscht auf allen verfügbaren Schnittstellen.
    1. Geben Sie in das Feld Port die Nummer des Ports ein, über den der Server erreichbar sein soll. Der Standardport ist „5883“.
    Hinweis: Stellen Sie sicher, dass der eingegebene Port nicht von anderen Programmen verwendet wird. Wenn der API-Server aus dem Internet erreichbar sein soll, müssen Sie den Port auch in Ihrem Router freigeben. Prüfen Sie außerdem, ob Sie Ihre Firewall-Einstellungen anpassen müssen.
    1. Wählen Sie im Dropdown-Menü Zertifikat ein SSL-Zertifikat. Wenn Sie ein Zertifikat angeben, verarbeitet die API nur HTTPS-Anfragen.
    Alternative: Klicken Sie auf die Schaltfläche Zertifikat erzeugen, um ein neues selbstsigniertes Zertifikat zu erzeugen.
    Detail: Wenn Sie als Schnittstelle nicht 127.0.0.1 angegeben haben und Windows Defender verwenden, erstellen Sie optional eine Firewall-Regel. Aktivieren Sie dazu die Option Firewall-Regel für Windows Defender anlegen. Legen Sie Regeln für andere Firewall-Programme manuell an.
    1. Aktivieren Sie die Option Als Dienst anlegen.
    Detail: Aktivieren Sie optional die Option Eigenes Benutzerkonto verwenden. Geben Sie dann den Windows-Benutzernamen des Windows-Kontos einschließlich der Domäne ein, zum Beispiel „FIRMAsrv_manu.mustermensch“. Geben Sie außerdem das Windows-Passwort des Windows-Kontos ein. Siehe Informationen zum Einrichten einer Instanz von JTL-Wawi API
    Hinweis: Wenn Sie fehlerhafte Zugangsdaten eingeben, bleibt die Schaltfläche Speichern deaktiviert. Prüfen Sie deshalb Ihre Eingaben in den Feldern Windows-Benutzer und Windows-Passwort, wenn die Schaltfläche ausgegraut ist.
    1. Klicken Sie auf die Schaltfläche Speichern. Das Dialogfenster wird geschlossen. In der Registerkarte Dienste des Dialogfensters JTL-Administrator sehen Sie jetzt die Instanz. In der Spalte Status prüfen Sie jederzeit, ob die Instanz ausgeführt wird.

    Sie haben erfolgreich eine Instanz für JTL-Wawi API eingerichtet. Diese Instanz haben Sie als Windows-Dienst angelegt. Die Instanz startet jetzt automatisch im Hintergrund, sobald Sie Ihren Rechner hochfahren.

    Sie haben 2 Möglichkeiten zu prüfen, ob eine Instanz von JTL-Wawi API aktiv ist.

    Möglichkeit 1: In JTL-Administrator
    1. Öffnen Sie das Startmenü von Windows, indem Sie auf das Startsymbol klicken oder auf die Windows-Taste auf Ihrer Tastatur.
    2. Geben Sie in das Suchfeld JTL-Administrator ein.
    3. Öffnen Sie die App JTL-Administrator.
    1. Im neuen Dialogfenster JTL-Administrator sehen Sie in der Registerkarte Dienste eine Liste aller API-Instanzen. In der Spalte Status sehen Sie, ob die Instanz aktiv ist.
    Möglichkeit 2: In einem Browser
    1. Geben Sie in die Adresszeile eines Browsers die folgende Adresse ein: http://[IP-Adresse]:[Port]/swagger, zum Beispiel http://127.0.0.1:5883/swagger.
    2. Wenn die Instanz aktiv ist, sehen Sie eine Seite mit dem Titel JTL-Wawi API. Dort sehen Sie eine Liste aller verfügbaren API-Routen (z. B. /feature, /printers, /companies).

      Wenn die API-Instanz nicht aktiv ist, sehen Sie eine Fehlermeldung, zum Beispiel „Diese Website ist nicht erreichbar“ oder „Verbindung fehlgeschlagen“.

    Wie geht es weiter?

    Sie können jetzt in JTL-Wawi eine App über die Schnittstelle registrieren. Siehe JTL-Wawi API nutzen