Verbinden von dash.bar und der JTL-Wawi API

Geändert am Tue, 14 May 2024 um 11:19 AM


Die JTL-Wawi API ist noch ein sehr neues Projekt von JTL, das zukünftig sicher die Grundlage für viele neue Features und Erweiterungen von dash.bar sein wird. Aktuell hast du nach der Verbindung in deinem dash.bar Account bereits Zugriff auf ein Widget über die Wawi-Bestellungen, das die Bestelldaten aus sämtlichen, mit der JTL-Wawi verbundenen, Verkaufskanälen enthält und dazugehörige Detailseiten mit mehr Informationen über die einzelnen Bestellungen. Um diese Features nutzen zu können, musst du allerdings einamalig deinen Account bei dash.bar mit deinem JTL-Wawi API-Server verknüpfen, sodass dir diese Daten in der App auch angezeigt werden können. Wie das funktioniert erfährst du hier.


INHALTSVERZEICHNIS


Eine Step-by-Step Anleitung:


Step 1: Den Server starten

Damit dir dash.bar auch Daten aus deiner JTL-Wawi anzeigen kann, musst du im ersten Schritt einmal den zur Wawi gehörigen REST-API Server starten. Der Prozess dazu ist bereits von JTL sehr ausführlich auf der im Nachfolgenden verlinkten Seite erklärt. Wichtig ist nur, dass der Server über das Internet erreichbar ist, damit dash.bar auch mit ihm kommunizieren kann. Die URL unter der dein Server erreichbar ist, wirst du in den nachfolgenden Schritten noch brauchen.


Step 2:  In der Wawi auf eine Verbindung warten

Im nächsten Schritt musst du deine JTL-Wawi (Neue Oberfläche Beta) öffnen und dort unter dem Menüpunkt "Admin">"JTL-Wawi API" auf eine Verbindungsanfrage warten.  (Auch hierzu gibt es noch einmal eine ausführliche Anleitung von JTL.) Sobald du das unten gezeigte Fenster siehst, kannst du zu Schritt 3 übergehen.




Step 3: Der Verbindungsprozess

Nun ist es an der Zeit die eigentliche Verbindung herzustellen.

  • Dafür begibst du dich zunächst in die Einstellungen deines dash.bar Accounts. Im Web findest du die Verbindungseinstellungen unter dem Tab "Verbindungen", in der App findest du die entsprechende Seite unter "Shop">" Einrichtung"


  • Anschließend musst du die obengenannte API-URL eintragen, also die Adresse, unter der dein JTL-Wawi API-Server erreichbar ist. Dies sollte eine Adresse der Form https://beispiel.api-url.de sein. Bevor du die erste Anfrage abschickst überprüfe bitte noch einmal, ob dein API-Server läuft und du das oben gezeigte Fenster in der JTL-Wawi geöffnet hast.


  • Nachdem die erste Anfrage verschickt ist, wird dir im besten Fall angezeigt, dass sie erfolgreich gesendet wurde. Sollte dies nicht der Fall sein und du eine Fehlermeldung erhalten haben, kannst du dich unter diesem Step-by-Step Guide darüber informieren, was die einzelnen Fehler zu bedeuten haben.



  • War die erste Anfrage erfolgreich, solltest du in dem Einrichtungsassistenten deiner JTL-Wawi eine Verbindungsanfrage angezeigt bekommen. Diese kannst du nun annehmen. Wie du das genau machst und was du dabei beachten musst, findest du in dem dazugehörigen Artikel von JTL.






Hinweis: Wenn du an dieser Stelle auf Zurück klickst, gehen die Daten, die JTL-Wawi zu diesem Zeitpunkt empfangen hat, verloren und JTL-Wawi muss erneut eine Registrierungsanfrage Ihrer Anwendung über die Schnittstelle entgegennehmen


  • Hast du die Anfrage angenommen, kannst du im nächsten Schritt in dash.bar auf "Verbindung bestätigen" klicken. Hat bisher alles geklappt, sollte deine JTL-Wawi nun mit dash.bar verknüpft sein und die dazugehörigen Features, wie Widgets und Detailseiten, sollten in vollem Umfang nutzbar sein.




Fehlerbehandlung:


Beim Durchführen der Verbindung kann es zu verschiedenen Fehlermeldungen kommen, was sie bedeuten und was du dagegen tun kannst erfährst du in diesem Abschnitt. 


Fehlermeldung 1: Kein API-Server unter der angegebenen Adresse gefunden 



Wenn du diesen Fehler angezeigt bekommst, musst du mehrere Dinge überprüfen. Zunächst solltest du sicherstellen, dass du dich beim Eingeben der URL nicht vertippt hast oder beispielsweise das https:// vergessen hast. Kannst du das ausschließen, solltest du sichergehen, dass du den API-Server gestartet hast und er ordnungsgemäß funktioniert. Dies kannst du zum Beispiel über die Swagger UI testen, deren URL dir nach dem Start des Servers angezeigt werden sollte.







Kannst du auch diese Fehlerquelle ausschließen, liegt es vielleich daran, dass dein API-Server nicht von außen, über das Internet erreichbar ist. Dies ist nicht immer ganz einfach aufzusetzen, deswegen solltest du dir, falls du nicht selbst über IT Fachwissen verfügst, jemanden zuhilfe holen, der dich bei diesem Prozess unterstützt. 





Fehlermeldung 2: Kein aktiver Einrichtungsassistent gefunden



Wird dir diese Fehlermeldung angezeigt, ist das bereits eine gute Nachricht, denn es bedeutet dass dein API-Server erreicht werden konnte und geantwortet hat. Allerdings wurde in der dazugehörigen JTL-Wawi kein offener Einrichtungsassistent gefunden. Wie du diesen öffnen kannst, ist unter Step 2 dieses Artikels zu finden. Sobald du das dort abgebildete Fenster siehst und sichergestellt hast, dass du einmal auf "Weiter" geklickt hast, kannst du die Anfrage in dash.bar einfach noch einmal senden und die Fehlermeldung sollte verschwunden sein.





Fehlermeldung 3: Anfrage bereits vorhanden  



Siehst du diese Fehlermeldung, können zwei Dinge die Ursache dafür sein: 


  1.  Du hast die Anfrage schon einmal gesendet. In diesem Fall kannst du einfach ganz normal im Anmeldeprozess fortfahren, die Anfrage in der Wawi annehmen und anschließend auf "Verbindung bestätigen" klicken.                                                
  2. Es ist noch eine veraltete Verbindung in der JTL-Wawi gespeichert. Dies kann passieren, wenn du dash.bar schon einmal mit deiner JTL-Wawi verbunden hattest, diese Verbindung dann allerdings wieder getrennt hast. In diesem Fall musst du die alte Verbindung in der Wawi erst löschen. Danach sollte das Verbinden ganz normal funktionieren.                                


Fehlermeldung 4: Anfrage noch nicht angenommen




Wie die Fehlermeldung schon sagt, wurde die Verbindung in der JTL-Wawi vermutlich noch nicht genehmigt. Bitte stelle sicher, dass du den Registrierungsprozess wirklich vollständig abgeschlossen und am Ende auf "Fertigstellen" geklickt hast. 

Siehst du dash.bar in diesem Fenster aufgelistet, kannst du mit dem Bestätigen der Verbindung fortfahren. Der Haken bei "Registrierung abgeschlossen" erscheint erst wenn du die Verbindung bestätigt und das unten gezeigte Fenter einmal geschlossen und wieder geöffnet hast.





Fehlermeldung 5: Fehler beim Verbindungsprozess



Dieser Fehler weist meist darauf hin, dass die Reihenfolge der Schritte nicht eingehalten wurde. Zum Beispiel, dass während eine Anfrage lief, der Assistent in der Wawi geschlossen wurde. Bitte versuche es noch einmal und halte hierbei die oben beschriebene Reihenfolge ein. 




Fehlermeldung 6: Die Verbindung wurde von der Wawi abgelehnt



Dieser Fehler kann auftreten, wenn du die Anfrage in der Wawi nicht angenommen hast. Das kann auch unabsichtlich passieren, etwa wenn du auf "Zurück", statt "Weiter" klickst und die Anfrage somit abbrichst oder auch wenn du den Einrichtungsassistenten im Hintergrund versehentlich geschlossen hast. 



 




Tags: