JTL WAWI

JTL-Wawi API – Einrichtung und App-Registrierung

🎯 Ziel

In diesem Guide erfahren Sie, wie Sie die JTL-Wawi API aktivieren, vorbereiten und Ihre Anwendung (App) registrieren. Die Anleitung führt Sie durch die notwendigen Voraussetzungen und erklärt die grundlegenden Schritte zur Einrichtung und App-Registrierung – auch in Zusammenarbeit mit melibo.


🔧 Voraussetzungen

Stellen Sie sicher, dass alle folgenden Punkte erfüllt sind, bevor Sie mit der Einrichtung beginnen:

1. Lizenz für die JTL-Wawi API

Sie benötigen eine gültige API-Lizenz, die im JTL-Kundencenter gebucht wurde. ➜ JTL-Kundencenter ➜ Anleitung: Lizenz für JTL-Wawi API buchen


2. Gestarteter JTL-Wawi API REST-Server

Damit Ihre App mit der JTL-Wawi API kommunizieren kann, muss eine aktive Instanz des JTL-Wawi API REST-Servers laufen. Diese wird über den JTL-Administrator gestartet.

Voraussetzungen

  • Sie haben bereits eine Instanz der JTL-Wawi API im JTL-Administrator eingerichtet. ➜ Anleitung: Instanz von JTL-Wawi API für manuellen Start in JTL-Administrator einrichten

  • Sie verwenden mindestens JTL-Wawi Version 1.10. ➜ JTL-Wawi herunterladen: https://www.jtl-software.de/wawi-download

  • In älteren Versionen muss die API manuell gestartet werden. ➜ Siehe: API-REST-Server starten

  • Hinweis: Die JTL-Wawi API befindet sich derzeit in der Open-Beta-Phase. Bis zum offiziellen Release ist die Nutzung kostenfrei, kann danach aber je nach gebuchter JTL-Edition eingeschränkt sein. ➜ Übersicht der Editionen

Schritt-für-Schritt: JTL-Wawi API-Instanz manuell starten

  1. Öffnen Sie das Windows-Startmenü (Startsymbol oder Windows-Taste).

  2. Geben Sie im Suchfeld JTL-Administrator ein.

  3. Öffnen Sie die Anwendung JTL-Administrator.

  4. Wechseln Sie im geöffneten Fenster zur Registerkarte „Dienste“.

  5. Suchen Sie in der Liste der Dienste Ihre API-Instanz.

  6. Klicken Sie in der entsprechenden Zeile auf Starten, um die Instanz zu aktivieren.

Nach wenigen Sekunden sollte der Status der Instanz auf aktiv stehen. Damit ist Ihre JTL-Wawi API erfolgreich gestartet.

Alternative: Automatischer Start

Statt die Instanz manuell zu starten, können Sie sie auch als Windows-Dienst konfigurieren. Dadurch wird der API-Server automatisch beim Hochfahren Ihres Computers gestartet. ➜ Anleitung: Instanz von JTL-Wawi API mit automatischem Start in JTL-Administrator einrichten

📌 Exkurs: Sie können jederzeit prüfen, ob eine API-Instanz aktiv ist, indem Sie im JTL-Administrator in der Spalte Status nachsehen. Nur eine aktive Instanz kann Anfragen von externen Anwendungen verarbeiten.

Nach erfolgreichem Start können Sie mit der App-Registrierung fortfahren. ➜ Weiterführend: JTL-Wawi API nutzen


3. Vollständige App-Daten

Ihre Anwendung muss alle notwendigen Informationen enthalten, die die JTL-Wawi API für die Identifikation und Registrierung benötigt. ➜ Dokumentation: JTL-Wawi API appRegistration

📌 Tipp: Vergewissern Sie sich, dass der Windows-Dienst der JTL-Wawi API korrekt läuft, bevor Sie die App-Registrierung starten.


🪜 Schritt-für-Schritt-Anleitung zur App-Registrierung

Schritt 1: Voraussetzungen prüfen

Überprüfen Sie, ob:

  • die Lizenz aktiv ist,

  • der API-Dienst läuft,

  • und Ihre App die erforderlichen Registrierungsdaten enthält.

Schritt 2: Verbindung zur API herstellen

Stellen Sie eine Verbindung zur JTL-Wawi API her, indem Sie den laufenden REST-Server über die angegebene URL (z. B. https://<servername>:port) ansprechen.

Schritt 3: App-Registrierung durchführen

Registrieren Sie Ihre Anwendung über die JTL-Wawi API-Schnittstelle. Die Registrierung erfolgt durch Übermittlung der erforderlichen App-Daten (z. B. appName, redirectUri, appKey) an den Endpunkt /appRegistration.

💡 Sie können die App-Registrierung auch in Zusammenarbeit mit melibo vornehmen. melibo unterstützt Sie bei der Integration und Konfiguration der JTL-Wawi API, um eine reibungslose Verbindung zwischen Ihrer Anwendung und JTL-Wawi sicherzustellen.


✅ Ergebnis

Nach erfolgreicher Durchführung:

  • ist Ihre Anwendung über die JTL-Wawi API registriert,

  • kann sicher mit der JTL-Wawi-Instanz kommunizieren,

  • und Sie können API-Endpunkte für Ihre Prozesse (z. B. Produkt-, Kunden- oder Auftragsdaten) verwenden.


🧭 Weiterführende Ressourcen

  • JTL-Wawi API Dokumentation: https://wawi-api.jtl-software.com/

  • JTL-Guide Übersicht: https://guide.jtl-software.com/jtl-wawi/jtl-wawi-api/

Zuletzt aktualisiert

War das hilfreich?