PORTAL und PPS Knowledge Base

Medienstream API

Owned by Former user (Deleted)
Last updated: 2024-02-09 by Kathrin Janka
2 min read

Mithilfe der PEIQ Cloud-Connect APIs (engl. Application Programming Interfaces, Programmierschnittstellen) können Verlage Teile ihrer bestehenden Systeme und Produkte mit dem PEIQ PORTAL verbinden. Alle Cloud-Connect APIs sind nach der REST-Architektur aufgebaut. Der Zugriff wird dabei über die Standard-HTTP-Methoden GET, POST, PUT und DELETE gesteuert. Die Zugriffskontrolle erfolgt hierbei über eine Implementierung nach OAuth V2 Standard.

Über die Endpunkte der Medienstream API können die im PORTAL vorliegenden Medienstreams nach verschiedenen Filtern abgerufen, upgedatet oder gelöscht sowie neue Medienstreams angelegt werden.

Funktionalitäten der Medienstream API

  • Abrufen von Medienstreams nach verschiedenen Filtern oder anhand der ID

  • Erstellen, Editieren und Löschen von Medienstreams im PORTAL

Inhaltsverzeichnis

Allgemeine Beschreibung

Die Medienstream API ist der API Endpunkt der Medienstreams. Über die unten genannten Endpunkte können die im PORTAL vorliegenden Medienstreams nach verschiedenen Filtern abgerufen, upgedatet oder gelöscht sowie neue Medienstreams angelegt werden.

Verfügbare Endpunkte für Streaming Media

  • GET /streamingmedia: Gibt eine paginierte Liste an Medienstreams nach den gesetzten Filtern aus.

  • GET /streamingmedia/{streaming_media_id}: Gibt den durch die ID spezifizierten Medienstream zurück.

  • POST /streamingmedia: Erstellt einen neuen Medienstream.

  • PUT /streamingmedia/{streaming_media_id}: Aktualisiert die im Request Body angegebenen Informationen des durch die ID spezifizierten Medienstreams.
    plugin_type sowie remote_id können nicht aktualisiert werden!

  • DELETE /streamingmedia/{streaming_media_id}: Löscht den durch die ID spezifizierten Medienstream unwiderruflich.

Dokumentation nach Open API Specification

Die API-Dokumentation ist als interaktive Dokumentation für berechtigte Admins direkt im jeweiligen PORTAL unter /admin/api/v2/doc?module=streaming_media erreichbar.

Das swagger-File kann auch hier heruntergeladen werden (Stand: Apr 27, 2022):

Wichtige Hinweise zum Sync-Handling bei Upload-Plugins (z. B. JW-Upload-Plugin)

Die optional aktivierbaren Sync-Workflows (insbesondere bei Upload-Plugins im Falle von Bearbeitung, Re-Upload und Löschung über das User-Interface des PEIQ PORTALs) werden von der API nicht unterstützt und müssen vom über die API angebundenen Drittsystem gehandelt werden.

Über die Medienstream-API erstellten Medienstreams erhalten automatisch vom PORTAL ein flag sync_disable.

Trouble Shooting bei HTTP Status Codes

400 - Bad Request

Unter Umständen kann auch die Dubletten-Prüfung angeschlagen haben

404 - Not Found

Verwandte Seiten

 

Impressum