REST Bildkonverter

Produktbilder, die aus einem PIM oder einer Warenwirtschaft in den Shop kommen, sind selten für den Web-Einsatz optimiert. Der Bildkonverter bringt sie in die benötigten Formate und Größen und senkt damit die Ladezeiten. Über diese Schnittstelle stoßen Sie ihn automatisiert an, statt ihn nach jedem Produktdatenimport von Hand zu starten. Alle Aufrufe brauchen ein Token, siehe REST-Authentifizierung. Content-Type ist durchgängig application/json.

Konvertierung starten

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

Liefert im Erfolgsfall ein leeres JSON-Objekt. Das heißt, der Vorgang wurde gestartet, nicht dass er fertig ist.

Konvertierung abbrechen

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

Liefert im Erfolgsfall ebenfalls ein leeres JSON-Objekt.

Fortschritt abfragen

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

Feld	Typ	Beschreibung
`state`	String	Zustand des Vorgangs, siehe Tabelle unten
`startTime`	String	Zeitpunkt, an dem der letzte oder laufende Vorgang gestartet wurde
`progress`	Object	Informationen über den Fortschritt
`progress.percentage`	Integer	Fortschritt in Prozent
`progress.currentFile`	String	Datei, die aktuell oder zuletzt konvertiert wurde. Nur in den Zuständen `running` und `canceled` gefüllt, sonst leer.
`progress.successCount`	Integer	Anzahl korrekt konvertierter Dateien
`progress.errorCount`	Integer	Anzahl Dateien, bei denen ein Fehler auftrat
`progress.totalFileCount`	Integer	Gesamtzahl der zu konvertierenden Dateien

Die möglichen Zustände:

Zustand	Bedeutung
`init`	Es liegen keine Informationen über einen laufenden oder abgeschlossenen Vorgang vor. Die Felder `progress` und `startTime` fehlen.
`running`	Ein Vorgang läuft. `progress` enthält den aktuellen Stand.
`error`	Es läuft kein Vorgang. Der letzte konnte wegen eines Fehlers nicht korrekt gestartet werden.
`finished`	Es läuft kein Vorgang. Der letzte wurde erfolgreich beendet. `progress` enthält den Stand bei 100 Prozent.
`canceled`	Es läuft kein Vorgang. Der letzte wurde vorzeitig abgebrochen. `progress` enthält den Stand zum Zeitpunkt des Abbruchs.

{
    "state": "running",
    "startTime": "2017-01-01 12:30:35",
    "progress": {
        "percentage": 22,
        "currentFile": "p12345.jpg",
        "successCount": 30,
        "errorCount": 3,
        "totalFileCount": 150
    }
}

Beachten Sie, dass finished nur aussagt, dass der Vorgang durchgelaufen ist, nicht dass alle Bilder fehlerfrei konvertiert wurden. Werten Sie dafür errorCount aus.

Schnittstellen

Konvertierung starten

Konvertierung abbrechen

Fortschritt abfragen

Verwandte Themen

​Konvertierung starten

​Konvertierung abbrechen

​Fortschritt abfragen

​Verwandte Themen

Konvertierung starten

Konvertierung abbrechen

Fortschritt abfragen

Verwandte Themen