Zum Hauptinhalt springen
Der Endpunkt videos/ stellt eine Schnittstelle zur Verwaltung von Videos im Shop-System bereit. Über die API können Videos hochgeladen und die zugehörigen URLs abgefragt werden. Unterstützt werden verschiedene Videoformate sowie individuelle Einschränkungen wie maximale Dateigröße und erlaubte Formate, die über die Shop-Konfiguration content.videoSettings gesteuert werden.

​
Unterstützte Methoden

Angabe aller unterstützten Methoden.
Befehl/InfoEndpunkteGETPUTPOSTDELETE
Video URL
Video Upload

​
Allgemein

  • Unterstützte Videoformate:
    • mp4
    • avi
    • mov
    • wmv
    • flv
    • mkv
    • webm
    • mpeg
    • 3gp
    • ogg/ogv
  • Maximale Dateigröße
    Wird über die Konfiguration content.videoSettings festgelegt.
  • Erlaubte Formate
    Die zulässigen Videoformate können ebenfalls über content.videoSettings konfiguriert werden.

​
Methoden für Video Upload

​
GET videos/url/{typeId}

Dieser Endpunkt liefert die URL, unter der Videos des angegebenen Typs (z. B. Kategorie- oder Produktvideos) gespeichert werden. Der Pfadparameter typeId muss den Wert categories oder products haben.

​
Beispiel

http://www.<ihr-shop>.de/admin/api/v1/videos/url/categories

​
Antwort

{
    "url": "//content.myshop.localhost/categories/video"
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Kategorie- oder Produkt-Daten.
400 Bad Request”invalidValue”
400 Bad Request”missing”subshopId wurde nicht übergeben.

​
POST videos/upload/{typeId}

Dieser Endpunkt ermöglicht das Hochladen eines Videos für einen angegebenen Typ (z. B. Kategorien oder Produkte). Der Pfadparameter typeId muss den Wert categories oder products haben. Der Request-Body muss den Dateinamen (fileName) sowie die Binärdaten des Videos (videoData) enthalten. Nach einem erfolgreichen Upload wird der Name der hochgeladenen Datei zurückgegeben. Schreibberechtigungen für Kategorie- oder Produktdaten sind erforderlich.

​
Beispiel

http://www.<ihr-shop>.de/admin/api/v1/videos/upload/categories?subshopId=deutsch

​
Request Body

Content-Type: multipart/form-data

fileName: myVideo.mp4
videoData: <Binärdaten der Videodatei>

​
Antwort

{
    "newFile": "myVideo.mp4"
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben Kategorie- oder Produkt-Daten.
400 Bad Request”missing”subshopId wurde nicht übergeben.
video wurde nicht übergeben (wenn fileName oder videoData fehlen oder leer sind).
400 Bad Request”invalidValue”
400 Bad Request”invalidFileFormat”Das Video hat ein ungültiges Format.
503 Service Unavailable”internalError”Das Hochladen ist fehlgeschlagen.

​
Support

Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum Kundenportal Bitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.