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 |
---|---|---|
state | String | Mögliche Werte:
|
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
{ "state": "running", "startTime": "2017-01-01 12:30:35", "progress": { "percentage": 22, "currentFile": "p12345.jpg", "successCount": 30, "errorCount": 3, "totalFileCount": 150 } }
Add Comment