REST Bildkonverter

Die Optimierung und Komprimierung von Produktbildern in Ihrem Onlineshop ist ein unverzichtbarer Schritt, um die Benutzererfahrung zu verbessern, die Performance zu steigern, die Sichtbarkeit in Suchmaschinen zu erhöhen und die Effizienz des gesamten E-Commerce-Betriebs zu steigern.

Produktbilder, die über Ihre PIM (Product Information Management) oder Warenwirtschaft an den Onlineshop übertragen werden, sind oft nicht ausreichend für den Web-Einsatz optimiert und komprimiert.

Hier kann der WEBSALE Bildkonverter helfen.
Mehr Informationen zum WEBSALE Bildkonverter finden Sie in der WEBSALE Online Dokumentation unter dem Punkt Wegweiser > SEO > Bildkonverter

Durch einen REST-Aufruf kann der Bildkonverter automatisiert gestartet werden, um die Produktbilder einer umfassenden Konvertierung und Optimierung zu unterziehen. In diesem Prozess werden die Bilder an ihre spezifischen Anforderungen und Formate angepasst, um eine maximale visuelle Wirkung zu erzielen und die Ladezeiten der Webseite zu minimieren.


Inhaltsverzeichnis


API Bildkonverter

Konvertierung der Bilder starten

Request

POST https://www.websale.de/api/images/convert/start

Content-Type

application/json

Authorization-Token

benötigt

Response

Liefert im Erfolgsfall ein leeres JSON-Objekt.


Konvertierung der Bilder abbrechen

Request

POST https://www.websale.de/api/images/convert/cancel

Content-Type

application/json

Authorization-Token

benötigt

Response

Liefert im Erfolgsfall ein leeres JSON-Objekt.


Fortschritt der Konvertierung abfragen

Request

GET https://www.websale.de/api/images/convert/state

Content-Type

application/json

Authorization-Token

benötigt

Response

Liefert im Erfolgsfall ein JSON-Objekt mit folgender Struktur: 

Feld

Typ

Beschreibung

Feld

Typ

Beschreibung

state

String

Mögliche Werte:

  • init: Es liegen keine Informationen über einen laufenden oder abgeschlossenen Konvertierungsvorgang vor.
    Es werden keine Felder progress und startTime mitgeliefert.

  • running: Es läuft gerade ein Konvertierungsvorgang. Das Feld progress beinhaltet Informationen zum aktuellen Fortschritt. 

  • error: Es läuft gerade keine Konvertierung. Der letzte Vorgang konnte aufgrund eines Fehlers nicht korrekt gestartet werden.

  • finished: Es läuft gerade keine Konvertierung. Der letzte Vorgang wurde erfolgreich beendet.
    Das Feld progress Feld beinhaltet Informationen zum Fortschritt, als dieser 100 % erreicht hat.

  • canceled: Es läuft gerade keine Konvertierung. Der letzte Konvertierungsvorgang wurde vorzeitig abgebrochen.
    Das Feld progress Feld beinhaltet Informationen zum Fortschritt zu dem Zeitpunkt, als der Vorgang abgebrochen wurde.

startTime

String

Zeitpunkt, an dem der letzte bzw. der aktuelle Konvertierungsvorgang gestartet wurde.

progress

Object

Informationen über den Fortschritt des aktuellen bzw. des zuletzt beendeten Konvertierungsvorganges.

progress.percentage

Integer

Fortschritt des Konvertierungsvorgangs in Prozent.

progress.currentFile

String

Name der Bilddatei, die aktuell konvertiert wird bzw. zuletzt konvertiert wurde. Nur gesetzt im State running oder canceled, ansonsten ein leerer String.

progress.successCount

Integer

Anzahl der Dateien, die korrekt konvertiert werden konnten.

progress.errorCount

Integer

Anzahl der Dateien, bei deren Konvertierung ein Fehler aufgetreten ist.

progress.totalFileCount

Integer

Gesamtzahl der Dateien, die konvertiert werden sollen.

Beispiel