/images/ bietet Ihnen umfassende Funktionen zur Verwaltung von Bildern unterschiedlicher Formate in unserem Shopsystem.
Über verschiedene Endpunkte können Sie Bilder hochladen, konvertieren, löschen sowie die zugehörigen URLs abrufen.
Unterstützte Methoden
Angabe aller unterstützten Methoden.| Befehl/Info | Endpunkte | GET | PUT | POST | DELETE |
|---|---|---|---|---|---|
| Image Upload | images/ |
Unterstützte Bildformate
BitmapFITSGIFGraphics Kernel SystemJPEGNIFFPMPNGXFIGXPMTIFFGIMP XCFwebpAVIF
Datenfelder eines Verzeichnisses
| Name | Typ | Verwendung |
|---|---|---|
| name | String | Der Name des Verzeichnisses |
| path | String | Der Pfad zum Verzeichnis |
| subDirectories | Array | Ein Array von Unterverzeichnissen |
Beispiel
Methoden zur Verwaltung von Bildern
GET images/url/
GET images/url/
Dieser Endpunkt liefert die URL eines Bildes basierend auf dem angegebenen Typ (typeId) und optional dem gewünschten Format.
Er wird verwendet, um den Speicherort eines Bildes im System zu ermitteln – insbesondere, wenn der Pfad nach dem Hochladen nicht bekannt ist.Gültige Werte für
typeId sind:
categoriesfür Kategoriebilder,productsfür Produktbilder,appImagesfür Bilder innerhalb der App-Oberfläche.
Beispiel
Antwort
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Kategorie-, Produkt- oder App-Daten. | |
| 400 Bad Request | ”invalidValue” | |
| 400 Bad Request | ”missing” | subshopId oder formatNodeId wurden nicht übergeben. |
GET images/directories/
GET images/directories/
Dieser Endpunkt liefert die Struktur der verfügbaren Bildverzeichnisse als Baumstruktur zurück. Je nach Wert des ParameterstypeId werden entweder Quellverzeichnisse (source) oder Zielverzeichnisse (target) ausgegeben. Die Antwort enthält eine hierarchische Darstellung der vorhandenen Ordner und Unterordner.
Beispiel
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von konvertierten Bildern. | |
| 400 Bad Request | ”invalidValue” |
GET images/convert/results
Dieser Endpunkt liefert eine paginierte Liste der Ergebnisse abgeschlossener Bildkonvertierungen. Für jedes konvertierte Bild werden Informationen wie Quelldatei, Zieldatei, Zielformat, Dateigröße, Dauer der Konvertierung und der Verarbeitungsstatus zurückgegeben. So kann nachvollzogen werden, ob und wie ein Bild erfolgreich in verschiedene Formate umgewandelt wurde.Query-Parameter
| Name | Typ | Verwendung |
|---|---|---|
| size | Number (optional) | Anzahl der Ergebnisse pro Seite. Standardwert wird verwendet, wenn nicht angegeben. |
| pageToken | String (optional) | Token für die nächste Seite. Wird in der Antwort als nextPageToken zurückgegeben. |
Beispiel
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von konvertierten Bildern. |
GET images/convert/status
Dieser Endpunkt liefert den aktuellen Status eines laufenden oder den letzten bekannten Status eines abgeschlossenen Bildkonvertierungsprozesses. Dabei werden Informationen wie Fortschritt, Anzahl erfolgreicher oder fehlgeschlagener Konvertierungen, sowie Timer-Daten (Startzeit, Endzeit, Dauer) zurückgegeben. Der Endpunkt ermöglicht die Überwachung und Auswertung von Bildkonvertierungsprozessen im System.Beispiel
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von konvertierten Bildern. | |
| 503 Service Unavailable | ”internalError” | Der Konvertierungsprozess kann nicht geprüft werden. |
GET images/report/products
Dieser Endpunkt liefert einen Bericht über die Nutzung von Produktbildern im Shopsystem. Dabei werden sowohl fehlende Bilder (missingImages) als auch ungenutzte Bilder (unusedImages) aufgelistet. Der Bericht hilft dabei, Bilddateien zu identifizieren, die keinem aktiven Produkt mehr zugeordnet sind oder die im System fehlen, und unterstützt so bei der Optimierung der Bilddatenverwaltung.
Beispiel
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Produktdaten. |
POST images/upload
Dieser Endpunkt ermöglicht das Hochladen eines Bildes in das Shopsystem. Das Bild wird als Base64-kodierter String im Request-Body übertragen. Zusätzlich kann angegeben werden, in welche Formate das Bild konvertiert werden soll. Nach dem erfolgreichen Upload wird der Pfad zur gespeicherten Bilddatei zurückgegeben.Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Veröffentlichen von konvertierten Bildern. | |
| 400 Bad Request | Request body konnte nicht geladen werden. | |
| 400 Bad Request | ”missing” | formats wurden nicht übergeben. |
| 400 Bad Request | ”invalidValue” | Ein Bildformat ist ungültig. imageData ist ungültig. |
| 400 Bad Request | ”invalidFormat” | Das Feld formats ist kein Array von Strings.Das Feld fileName ist kein String und kein Array von Strings.Das Feld imageData ist kein String und kein Array von Strings. |
| 400 Bad Request | ”invalidFileFormat” | Das Bild hat ein ungültiges Format. |
| 400 Bad Request | ”unknownDataField” | Request body enthält etwas außer fileName, imageData und formats. |
| 503 Service Unavailable | ”internalError” | Das Hochladen des Bildes ist fehlgeschlagen. |
POST images/upload/convert
Dieser Endpunkt ermöglicht das Hochladen eines Bildes mit anschließender sofortiger Konvertierung in ein oder mehrere definierte Zielformate. Das Bild wird als Base64-kodierter String im Request-Body übermittelt. Im Unterschied zum normalen Upload wird hier die Konvertierung automatisch angestoßen, sodass direkt optimierte oder formatangepasste Varianten erstellt werden können. Nach Abschluss wird eine Übersicht der erzeugten Bilddateien zurückgegeben.Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Veröffentlichen von konvertierten Bildern. Der Bildtyp wird in den Berechtigungen berücksichtigt. | |
| 400 Bad Request | Request body konnte nicht geladen werden. | |
| 400 Bad Request | ”missing” | formats wurden nicht übergeben. |
| 400 Bad Request | ”invalidValue” | Ein Bildformat ist ungültig. imageData ist ungültig. Es wurden mehrere Bilder übergeben. |
| 400 Bad Request | ”invalidFormat” | Das Feld formats ist kein Array von Strings.Das Feld fileName ist kein String und kein Array von Strings.Das Feld imageData ist kein String und kein Array von Strings. |
| 400 Bad Request | ”invalidFileFormat” | Das Bild hat ein ungültiges Format. |
| 400 Bad Request | ”unknownDataField” | Request body enthält etwas außer fileName, imageData und formats. |
| 503 Service Unavailable | ”internalError” | Das Konvertieren vom Bild ist fehlgeschlagen. |
| 503 Service Unavailable | ”serviceUnavailable” | Der Konvertierungsprozess konnte nicht gestartet werden. |
POST images/report
Dieser Endpunkt startet die Überprüfung der im System vorhandenen Bilder auf fehlende oder ungenutzte Dateien. Die Ausführung erfolgt asynchron: Nach dem erfolgreichen Start der Überprüfung wird kein direktes Ergebnis zurückgegeben. Der vollständige Bericht kann anschließend überGET /images/report/ abgerufen werden. Der Endpunkt stellt sicher, dass Bilddaten regelmäßig auf Konsistenz geprüft werden können.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Erstellen von Produkten. | |
| 503 Service Unavailable | ”serviceUnavailable” | Der Überprüfung konnte nicht gestartet werden. |
POST images/convert/start
Dieser Endpunkt startet den Konvertierungsprozess für im System gespeicherte Bilder. Dabei werden die Bilder in die jeweils definierten Zielformate umgewandelt (z. B. verschiedene Größen oder Dateiformate). Die Ausführung erfolgt asynchron, aber es wird nach dem Starten vom Prozess eine direkte Rückmeldung zu den konvertierten Bildern geliefert. Der Fortschritt und der Status der Konvertierung können später über den EndpunktGET /images/convert/status abgefragt werden.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Veröffentlichen von konvertierten Bildern. | |
| 400 Bad Request | Request body konnte nicht geladen werden. Das Format wurde nicht gefunden. Das Format hat ein ungültiges Quellverzeichnis oder es wurde ein ungültiges Quellverzeichnis angegeben. Es existieren keine Formate. Das Feld source enthält etwas außer format oder directory. | |
| 503 Service Unavailable | ”serviceUnavailable” | Der Konvertierungsprozess konnte nicht gestartet werden. |
| 503 Service Unavailable | ”internalError” | Der Konvertierungsstatus kann nicht abgerufen werden. |
POST images/convert/cancel
Dieser Endpunkt bricht einen aktuell laufenden Konvertierungsprozess für Bilder ab. Der Abbruch erfolgt nicht asynchron, es wird eine direkte Rückmeldung zu den konvertierten Bildern gleich geliefert. Nach der Ausführung kann der Status des Konvertierungsprozesses über den EndpunktGET /images/convert/status wieder abgefragt werden. Der Abbruchvorgang erfordert entsprechende Berechtigungen.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund |
|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Veröffentlichen von konvertierten Bildern. | |
| 503 Service Unavailable | ”internalError” | Der Konvertierungsprozess kann nicht geprüft werden. |
POST images/directories/
POST images/directories/
Ein Verzeichnis wird erstellt. BeitypeId = source handelt es sich um Quellverzeichnisse, bei typeId = target handelt es sich um Zielverzeichnisse.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund | |
|---|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Erstellen von konvertierten Bildern. | ||
| 400 Bad Request | Request body konnte nicht geladen werden. | ||
| 400 Bad Request | ”invalidValue” | name oder path ist ungültig. | |
| 400 Bad Request | ”missing” | name wurde nicht übergeben. | |
| 503 Service Unavailable | ”internalError” | Das Erstellen vom Verzeichnis ist fehlgeschlagen. |
DELETE images/directories/
DELETE images/directories/
Dieser Endpunkt löscht ein Verzeichnis innerhalb des angegebenen Bereichs (source oder target) für Bilddateien.
Über den Request-Body können der Pfad zum übergeordneten Verzeichnis sowie der Name des zu löschenden Ordners definiert werden. Nach erfolgreicher Löschung wird die aktualisierte Verzeichnisstruktur ohne das gelöschte Verzeichnis als Baumstruktur zurückgegeben.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund | |
|---|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Löschen von konvertierten Bildern. | ||
| 400 Bad Request | Request body konnte nicht geladen werden. | ||
| 400 Bad Request | ”invalidValue” | path fehlt oder ist leer. | |
| 404 Not Found | Das Verzeichnis wurde nicht gefunden. | ||
| 503 Service Unavailable | ”internalError” | Das Löschen vom Verzeichnis ist fehlgeschlagen. |
DELETE images/upload/
DELETE images/upload/
Dieser Endpunkt löscht eines oder mehrere Bilder innerhalb eines angegebenen Bereichs (categories, products oder appImages).
Der Name der zu löschenden Datei(en) wird über das Feld fileName im Request-Body angegeben, entweder als String oder als Array von Strings. Optional kann über das Feld formats angegeben werden, welche Bildformate berücksichtigt werden sollen; andernfalls werden alle Formate gelöscht. Der Endpunkt prüft sorgfältig die Gültigkeit der angegebenen Parameter und verarbeitet sowohl Einzel- als auch Mehrfachlöschungen.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund | |
|---|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben von Kategorie-, Produkt- oder App-Daten. | ||
| 400 Bad Request | Request body konnte nicht geladen werden. | ||
| 400 Bad Request | ”missing” | subshopId oder fileName wurden nicht übergeben. | |
| 400 Bad Request | ”invalidValue” | subshopId ist ungültig. Ein Bildformat ist ungültig. | |
| 400 Bad Request | ”invalidFormat” | Das Feld formats ist kein Array von Strings.Das Feld fileName ist kein String und kein Array von Strings. | |
| 400 Bad Request | ”unknownDataField” | Request body enthält etwas außer fileName und formats. | |
| 503 Service Unavailable | ”internalError” | Das Löschen von Bildern ist fehlgeschlagen. |
DELETE images/upload//
DELETE images/upload//
Dieser Endpunkt löscht ein bestimmtes Bild innerhalb eines angegebenen Bereichs (categories, products oder appImages).
Der zu löschende Dateiname wird direkt als Pfadparameter (filename) übergeben. Zusätzlich können im Request-Body weitere Dateinamen (fileName) angegeben werden, entweder als einzelner String oder als Array von Strings.
Über das optionale Feld formats kann festgelegt werden, welche Bildformate gelöscht werden sollen; andernfalls werden alle Formate berücksichtigt. Der Endpunkt unterstützt sowohl die Löschung eines einzelnen Bildes als auch die kombinierte Löschung mehrerer Bilder.
Beispiel
Request Body
Antwort
Fehlercodes
| Fehler | Typ | Grund | |
|---|---|---|---|
| 401 Unauthorized | Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben von Kategorie-, Produkt- oder App-Daten. | ||
| 400 Bad Request | Request body konnte nicht geladen werden. | ||
| 400 Bad Request | ”missing” | subshopId oder fileName wurden nicht übergeben. | |
| 400 Bad Request | ”invalidValue” | subshopId ist ungültig. Ein Bildformat ist ungültig. | |
| 400 Bad Request | ”invalidFormat” | Das Feld formats ist kein Array von Strings.Das Feld fileName ist kein String und kein Array von Strings. | |
| 400 Bad Request | ”unknownDataField” | Request body enthält etwas außer fileName und formats. | |
| 503 Service Unavailable | ”internalError” | Das Löschen von Bildern ist fehlgeschlagen. |
