API-Referenz Videos
- Leonid Simonov
- Jennifer Pusch
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.
Inhaltsverzeichnis:
1. Unterstützte Methoden
Angabe aller unterstützten Methoden.
Befehl/Info | Endpunkte | GET | PUT | POST | DELETE |
|---|---|---|---|---|---|
Video Upload | videos/ |
2. Allgemein
Unterstützte Videoformate:
mp4avimovwmvflvmkvwebmmpeg3gpogg/ogv
Maximale Dateigröße:
Wird über die Konfigurationcontent.videoSettingsfestgelegt.Erlaubte Formate:
Die zulässigen Videoformate können ebenfalls übercontent.videoSettingskonfiguriert werden.
3. Methoden für Video Upload
3.1 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/categoriesAntwort:
{
"url": "//content.myshop.localhost/categories/video"
}Fehlercodes:
Fehler | Typ | Grund |
|---|---|---|
401 Unauthorized |
| Nicht 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" |
|
3.2 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=deutschRequest Body:
{
"fileName": "myVideo.mp4",
"videoData": "AAAAIGZ0eXBtcDQyAAACAG1wNDFtcDQxaXNvbWF2YzEAAABkbW9vdgAAAGxt..."
}Antwort:
{
"newFile": "myVideo.mp4"
}Fehlercodes:
Fehler | Typ | Grund |
|---|---|---|
401 Unauthorized |
| Nicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben Kategorie- oder Produkt-Daten. |
400 Bad Request |
| Request body konnte nicht geladen werden. |
400 Bad Request | "missing" |
|
400 Bad Request | "invalidValue" |
|
400 Bad Request | "invalidFileFormat" | Das Video hat ein ungültiges Format. |
503 Service Unavailable | "internalError" | Das Hochladen ist fehlgeschlagen. |
4. 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.
© 2025 WEBSALE AG | Impressum | Datenschutz