> ## Documentation Index
> Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt
> Use this file to discover all available pages before exploring further.

# REST Bildkonverter

> Die Bildkonvertierung über REST starten, abbrechen und ihren Fortschritt abfragen, mit den Zuständen init, running, error, finished und canceled.

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](https://dokumentation.websale.de/v8s/schnittstellen/rest-osb-dienste/rest-authentifizierung.md). 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. |

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
    "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.

## Verwandte Themen

* Wegweiser: [REST-Schnittstelle für OSB-Dienste](https://dokumentation.websale.de/v8s/schnittstellen/rest-osb-dienste.md)
* Referenz: [Bildkonverter-Konfiguration wsimageconvert.cfg](https://dokumentation.websale.de/v8s/referenz/konfigurationen/bildkonverter-konfiguration-wsimageconvert-cfg.md)
* Wegweiser: [Spezielle Online-Dienste](https://dokumentation.websale.de/v8s/online-servicebereich/spezielle-online-dienste.md)


## Related topics

- [REST-Schnittstelle für OSB-Dienste](https://dokumentation.websale.de/v8s/schnittstellen/rest-osb-dienste.md)
- [API-Referenz Bildkonverter](https://dokumentation.websale.de/schnittstellen/admin-interface-api/api-referenz-bildkonverter.md)
- [Bildkonverter-Konfiguration wsimageconvert.cfg](https://dokumentation.websale.de/v8s/referenz/konfigurationen/bildkonverter-konfiguration-wsimageconvert-cfg.md)
- [Schnittstellen](https://dokumentation.websale.de/v8s/schnittstellen.md)
- [content - Katalog (Kategorien & Produkte)](https://dokumentation.websale.de/konfiguration/content-katalog-kategorien-produkte.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.