« Riverside für Business Funktionen: Übersicht
Die Riverside Business API hilft, manuelle Anstrengungen zu sparen, indem sie deinem Team programmgesteuert ermöglicht, Aufnahmemedien aus deinem Riverside-Konto abzurufen und das zu löschen, was nicht mehr benötigt wird.
Das kann deine Post-Produktions-Workflows optimieren, Dir ermöglichen, Inhalte in großem Umfang zu verwalten, und die Sicherheit der langfristigen Speicherung deiner Daten verbessern.
Wer: Kontoinhaber
Plan: Einige Business-Pläne, kontaktiere Deinen CSM
Gerät: Computer-Browser
Über die API
Die Riverside Business API unterstützt:
Aufnahmen
- Abrufen einer Liste von Produktionen mit zugehörigen Studios, Projekten und Aufnahmen.
- Abrufen einer Liste von Aufnahmen mit optionaler Filterung nach
Studio-IDoderProjekt-ID. Jede Aufnahme enthält Informationen über Spuren. - Abrufen einer einzelnen Aufnahme nach ihrer ID. Jede Aufnahme enthält Informationen über Spuren.
- Herunterladen der Mediendatei einer Spur.
- Herunterladen der Transkriptionsdatei einer Spur.
- Löschen einer Aufnahme nach ihrer ID.
Bearbeitungen
- Abrufen einer Liste von exportierten Bearbeitungen mit optionaler Filterung nach
Studio-ID,Projekt-IDoderAufnahme-ID. Abrufen einer einzelnen exportierten Bearbeitung nach ihrer ID
Herunterladen der Mediendatei einer exportierten Bearbeitung
Löschen einer exportierten Bearbeitung nach ihrer ID
Eine Liste von Bearbeitungen in Deinem Arbeitsbereich abrufen, mit optionaler Filterung nach Studio, Projekt oder Datumsbereich, indem Du den
List Edits-Endpunkt verwendest.
Exporte der Zeitleiste
Einen Timeline-Export für eine bestimmte Bearbeitung auslösen, indem Du den
Create Timeline ExportEndpunkt verwendest.Den Status eines Timeline-Exportjobs überprüfen und die Download-URL abrufen, indem Du den
Get Timeline-Endpunkt verwendest.Eine ZIP-Datei herunterladen, die die Timeline-Datei (XML oder AAF) und alle zugeordneten Medien enthält, indem Du den
Download Timeline File-Endpunkt verwendest.
Webinare
Registrieren von Webinar-Publikum mit deinen eigenen Formularen oder Zielseiten.
-
Eine Liste aller Webinare in Deinem Konto abrufen, indem Du den
Get Events-Endpunkt verwendest, einschließlich Registrierungsstatus, Anzahl der registrierten Personen und des öffentlichen Registrierungslinks.On-Demand-Webinare sind nicht in den Ergebnissen von Get Events enthalten. Verwende Webinar: Finde die Ereignis-ID, um deren IDs zu erhalten.
- Eine Liste der Webinar-Teilnehmer abrufen, indem Du den
Get Registrants-Endpunkt verwendest, einschließlich Teilnahmeinformationen, UTM-Zuordnung und benutzerdefinierten Registrierungsfeldern.- Füge
include=poll_answerszu DeinerGet Registrants-Anfrage hinzu, um die Antworten jedes Teilnehmers auf die während des Webinars gestarteten Umfragen zurückzugeben. - Die
Create Registrant- undGet Registrants-Endpunkte funktionieren auch mit On-Demand-Webinaren.
- Füge
Aktuell unterstützt die Riverside Business API nicht:
- Neue Funktionalitäten oder Apps entwickeln, die auf der Riverside-Plattform basieren (z. B. Integrationen und Apps).
API einrichten
Sobald Deine CSM die Funktion aktiviert, folge den untenstehenden Schritten, um sie einzurichten.
Schritt für Schritt
Melde Dich an bei Deinem Riverside-Konto.
- Klicke in der unteren linken Ecke auf den Konto-Menü.
- Klicke auf Einstellungen.
- Unter Team, klicke auf API.
- Unter API-Schlüssel generieren, klicke auf Generieren.
- Im Popup-Fenster, unter Dein API-Schlüssel, klicke auf Kopieren.
Dein API-Schlüssel wurde in die Zwischenablage kopiert.
Sobald das Pop-up geschlossen ist, läuft der Schlüssel ab. Generiere jederzeit einen neuen Schlüssel. - Folge der API Dev-Dokumentation hier.
Gut zu wissen
- Du kannst nur 1 API-Schlüssel generieren und nur 1 API-Schlüssel kann gleichzeitig aktiv sein.
- Das API-Zugriffslimit kann nicht geändert werden.
- Die Business-API ruft Daten ab, wenn Du sie anforderst. Um Riverside Webinar-Ereignisse automatisch an Deine Tools zu senden, während sie stattfinden, verwende Webhooks.
- Um deine Dateien in Google Drive zu speichern, verwende den Download-Datei-Endpunkt der API und richte dann Google's API ein, um die Dateien hochzuladen.