JTL REST API - appRegistration / erste Einrichtung

[Benjamin S.]

Hallo zusammen,
Die Open Beta der REST API wurde heute morgen ja veröffentlicht.
Gibt es schon eine Doku über die Scopes etc. bei der appRegistration?
In der Doku ist es als "todo" markiert: https://wawi-api.jtl-software.com/#tag/appRegistration/operation/Authentication_RegisterAppAsync

Ich bin also quasi bei step 4 in der Anleitung hier: https://guide.jtl-software.com/jtl-wawi/jtl-wawi-api/jtl-wawi-api-nutzen/

Und ohne die API tokens komme ich natürlich nicht an die anderen API Endpoints dran, ich hier überall den X-API token etc. brauche.

 

[Shopküche.de]

Die Scopes müssen als Array übermittelt werden:

{
    "AppId": "myApp/v3",
    "DisplayName": "My App",
    "Description": "Demo app for testing purposes",
    "Version": "3.0.0",
"AppIcon": "iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAABS5JREFUeNrsmjtIdUcQx/dej+834gPRKKZQMAhipzZWSZE0pkmRwiK9IWkEhVgEUikBC4tUooXBKulCCBhiYZUmhY0aRWN84Bvfr+xvcQ/nnru755wgxEscGK73njkz85+dmZ3d70s9PT2JXKa0yHF6A/BfU6qnpyf4vVZyt+QPJD+8wmD/IXlR8ob+0Xv+LJE8KvlTye+88qD/KflzyT/yJa+xsTElP796BlCZA1lTLfljyZeSf2dZPpL8RY6lfoHkbyQ3es/LURz3zfv7e/H4+JhZSKmUyMvLU7+Hn9kI+XQ6rfSF9yJ+9zwvDohepN6L6zyGampqRFFRkW8U53H69PRUFBcXK44CwTvn5+fi5uZG1NbWKjBaH85fXV2Js7MzpQdZB30IgIq4ADA4NDQk+vr6fCe1M1NTU2JgYED09/erqEYBmJ+fF8vLy2J8fFxUV1f7+oj80tKSmJ6eVkAA5AhoqyeVPZlQ2n5raWkRbW1tWcAqKipEc3OzaG1tjRWMuro6UVJSItrb20VZWVnGs83NTQWElYFt9PDw8AiAOPnmR8cU3dvbWwVOKoxdhTo97u7uTI4pWxqEA4DwdAHGLTxbTvKM2ohLhYWFTrukjmZbVqjgJ10BV7qtrq6KyspKZbSjoyNL9uLiQmxsbKiC3dnZsdrVXSi8AkF9uug9Lewaq/WLyJmKCiMs5+zsrFhYWBDl5eVibm4uC8D6+roYGxtTaUiBUku2gKAzKoX8FQi2MRcAVwrxO44RZVtkAXl5eenvJTbntE9RRayCqlMozsHGpYxn+fn5Shf5bUsN6gQAsAuAqQuFUyhyBcLRxkFTCiGnU9EVtXDDiJJzpZBfA0kARHWhOHmrn2EP0K4acAUjURHHAYAOVshlVNsK1pRNLioYeh9JtA/Y2mjQqDYcR0fSGghmRUYNIBwcwFxpEgeAbX4JBgsHbPpcALICgjG6RpwxWOetiUgfvbsWFBRYQfKMdsrfvBMlZwKgJ2AFlDnm6OgoowZsBX19fW2cXZBnIkUPBk0yEL8fHx/7bTQ4hYZnK3Sx2bkAqFmIjWVra8vZLvULzOjImwDs7+8rPRisqqqyjuPI4DxgmEJNALCxvb2tPl0phF1PV7TeKUtLS9WM3tvbmyHM7DI8PKxWwdYV9LK60lHLRZ3egvqco0SwaPmEOVUBJEh8j5pLgvyScokvtkw18FrvUN+uFl8lAFve0d5sB/aoXE1CFC9dCnt8utLXM+W6yUkO7Z2dnaKhocE6678UMXJz3cLBCH84Y9j0e+EoIsgdT5hQNjIyojYfU8To2S+1Ct3d3WJiYkI5f3BwICYnJ9VpzrTDe6ZT1cnJifUqxBZ9NjLXHU4SYrVhqL6+3nlZljbtlhy8kxDybP0vBSBIbJyuDS9tKkRuzNbW1mJfN87MzGSlj+3wb5o6/+0Ir1MowxJ5tru7K0ZHR8Xg4KDo6upSeQ/jAAMWq0SdrKysqGvAxcVF32E9SpC7QRDMVwxyQefpMKQeKWiKMvbQQ1pbQKT4F5q/uKY2DVRc/dENGJPpDDiEUQzS4g4PDxUQ/SwY/aampixn0Lm3t+evHMGirmwnQvRgBxD69i9EvwDgO/nHZ7Z+jLMoD17mhs+ttsnT5FDwDIDeqD6PHd6xrMA0KfSDDUD4ai8J2a5Wws7ZDj8x6Ezy93j3m+Sfc3CK+FryrwBg1/pE8rc54vjts69TwY3sSPKXIJL8vuR3KYFX5ji+zkv+SfLfktW8k3r7vxJvAP7nAP4RYACGIpOPAAgzRQAAAABJRU5ErkJggg==",
    "ProviderName": "JTL-Software-GmbH",
    "ProviderWebsite": "https://www.jtl-software.de",
    "MandatoryApiScopes": ["all.read"],
    "OptionalApiScopes": []
}

 

[Benjamin S.]

@Shopküche.de
Danke für die Antwort, das mit den Arrays macht Sinn.

Die Verbindung hat über die Swagger UI bei mir nicht funktioniert, über python aber ganz normal. Nur falls jemand das gleiche Problem hat.

 

[Shopküche.de]

Ich würde empfehlen mit Postman zu arbeiten: https://www.postman.com/
Über die Doku kann man die API-Spezifikationen herunterladen und in Postman importieren. So ist es leichter erstmal die App zu registrieren und die Endpoints zu testen.

 

[Benjamin S.]

Ich würde empfehlen mit Postman zu arbeiten: https://www.postman.com/
Über die Doku kann man die API-Spezifikationen herunterladen und in Postman importieren. So ist es leichter erstmal die App zu registrieren und die Endpoints zu testen.

Danke für den Tip, Postman macht das ganze echt leichter.

Noch eine Frage allerdings:
Seid ihr in der Lage POST calls zu machen?

GET funktioniert bei mir wunderbar nur bei POST calls bekomme ich einen 401 zurück:
https://forum.jtl-software.de/threads/jtl-api-post-nicht-moeglich-401-unauthorized.213922/

 

[juergenl]

Viele GET Befehle funktionieren mit der Authorisierung read.all während für Post jeweils der entsprechende Scope laut Dokumentation angemeldet werden muss. Also zum Beispiel "MandatoryApiScopes": ["all.read", "salesorder.createsalesorder"]

 

[Benjamin S.]

Viele GET Befehle funktionieren mit der Authorisierung read.all während für Post jeweils der entsprechende Scope laut Dokumentation angemeldet werden muss. Also zum Beispiel "MandatoryApiScopes": ["all.read", "salesorder.createsalesorder"]

Danke für die schnelle Antwort.

Wo findest du in der API denn die Namen der einzelnen scopes?
Hier z.B. kann ich nirgendwo den nötigen scope einsehen:
https://wawi-api.jtl-software.com/#tag/stock/operation/Stock_QueryStocksPerItemAsync

edit:

Folgender scope hat nun funktioniert, danke noch einmal
["stock.stockadjustment"]

 

[TiK]

Hallo zusammen, also nochmal zum Mitmeißeln, kann man die Scopes irgendwo nachlesen?
Danke!

 

[juergenl]

Bei jedem Endpoint kommt direkt oben nach der Beschreibung ein Punkt AUTHORIZATIONS: > den man aufklappen muss. Dann sieht man welche Rechte notwendig sind. Alle benötigten müssen bei der App-Registrierung in das Array mit den "MandatoryApiScopes": ["all.read",""customer.querycustomernotes "], eingetragen werden.

 

[apreng90]

wo kann man die API-Spezifikationen herunterladen, ich finde da nichts

 

[TiK]

https://wawi-api.jtl-software.com/

 

[TiK]

was mir noch aufgefallen ist: die alte Rest-API hatte Endpunkte um Angebote zu bearbeiten /v1/SalesQuotation, in der neuen sehe ich das nicht. Weiss jemand, ob das geplant ist? Wir stecken in einem Dilemma. In der alten API funktionieren ab JTL 1.7 Updates von Artikeln nicht mehr, es kommt ein Internal Server Error, wird auch nicht mehr repariert laut JTL, und in der neuen fehlen die SalesQuotation-Endpunkte, wir können uns jetzt zwischen Pest oder Cholera entscheiden... wir brauchen beide Funktionen und wollen nicht unbedingt in der Datenbank rumwühlen...

 

[kelvin.]

Die Angebote kannst du über die Endpunkte von den Aufträgen aufrufen. Da diese in der Datenbank die gleiche Tabelle teilen.
Get, patch und delete Funktionen sollten kein Problem sein.

Bei post bin ich mir nicht sicher, wie man da ein Angebot erstellt, weil da die Unterscheidung zwischen Angebot und Auftrag fehlt.

 

[TiK]

danke für den Tipp, es funktioniert. Muss keine Angebote anlegen, nur lesen und Positionen löschen/hinzufügen.

 

[Marc Völker]

was mir noch aufgefallen ist: die alte Rest-API hatte Endpunkte um Angebote zu bearbeiten /v1/SalesQuotation, in der neuen sehe ich das nicht. Weiss jemand, ob das geplant ist? Wir stecken in einem Dilemma. In der alten API funktionieren ab JTL 1.7 Updates von Artikeln nicht mehr, es kommt ein Internal Server Error, wird auch nicht mehr repariert laut JTL, und in der neuen fehlen die SalesQuotation-Endpunkte, wir können uns jetzt zwischen Pest oder Cholera entscheiden... wir brauchen beide Funktionen und wollen nicht unbedingt in der Datenbank rumwühlen...

Die kommen noch, vermutlich mit der 1.10. Wir evaluieren das gerade.

Die Angebote kannst du über die Endpunkte von den Aufträgen aufrufen. Da diese in der Datenbank die gleiche Tabelle teilen.
Get, patch und delete Funktionen sollten kein Problem sein.

Bei post bin ich mir nicht sicher, wie man da ein Angebot erstellt, weil da die Unterscheidung zwischen Angebot und Auftrag fehlt.

Ne das geht nicht, (sollte nicht gehen) du hast zwar recht, Datenbank Seitig ist das die gleiche Tabelle. Aber die Abfragen sollten nur Aufträge zurück geben.

 

[tdrzewosz]

Also bei mir rödelt der sich in Portman tot.

 

[Marc Völker]

Und was genau machst du da?