Arbeiten mit Ordnern

Einführung

Ordner können erstellt werden, um Videos in Ihrer Videobibliothek zu organisieren. Sie können Videos nach Betreff, Autor, Produkt, Region usw. sortieren. Wenn Sie Videos in Ordnern haben, können Sie diese in einem Konto mit Hunderten oder Tausenden von Videos einfacher verwalten.

Anmeldedaten für die CMS API

So verwenden Sie die CMS API Sie benötigen ordnungsgemäße Anmeldeinformationen.

Der einfachste Weg, um Anmeldeinformationen in den meisten Fällen zu erhalten, ist über den Bereich "Studio Admin API Authentication" (erfordert Administratorberechtigungen für Ihr Konto). Sehen API-Authentifizierungsdaten verwalten für Details. In diesem Fall sind die Berechtigungen, die Sie benötigen Videos - Sie benötigen Lese- und Schreibberechtigungen:

Wenn die von Ihnen benötigten Berechtigungen in Studio nicht verfügbar sind oder wenn Sie sie direkt von der OAuth API, benutze deine Wahl der Erhalten Sie Clientanmeldeinformationen Dokumente unten aufgeführt. Für welche Option Sie sich auch entscheiden, Sie müssen nach den richtigen Zugriffsberechtigungen fragen. Folgendes kann mit cURL oder Postman verwendet werden, um die richtigen Berechtigungen zu erhalten:

           "operations": [
           "video-cloud/videos/read",
           "video-cloud/videos/create",
           "video-cloud/videos/update"]

Erstellen von Ordnern

Hier sind die Informationen, die Sie benötigen, um einen neuen Ordner zu erstellen.

URL anfragen

Mach ein POST Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

Anfrage Körper

      {
        "name": folder_name
      }

Antwort

Die Antwort sieht folgendermaßen aus:

      {
        "id": "5a183efb10ab344b53775441",
        "account_id": "57838016001",
        "created_at": "2017-11-24T15:47:07.867Z",
        "name": "places",
        "updated_at": "2017-11-24T15:47:07.867Z",
        "video_count": 0
      }

Der Ordner id und name (Der Name, den Sie im Anfragetext angegeben haben) ist wichtig, da Sie beides benötigen füge ein Video zum Ordner hinzu. Mach dir keine Sorgen, wenn du das vergisst idweil Sie diese Informationen immer wieder erhalten können die Ordner bekommen für das Konto.

Ordner abrufen

Um ein Array von Ordnern für ein Konto zu erhalten, machen Sie einfach a GET Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders

Die Antwort sieht folgendermaßen aus:

      [
        {
          "id": "5a17275782aca45b631295f9",
          "account_id": "57838016001",
          "created_at": "2017-11-23T19:53:59.687Z",
          "name": "birds",
          "updated_at": "2017-11-23T20:06:24.537Z",
          "video_count": 1
        },
        {
          "id": "560039e5e4b0e69e4b01cacd",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:09:57.260Z",
          "name": "fish",
          "updated_at": "2017-11-02T19:03:40.751Z",
          "video_count": 4
        },
        {
          "id": "5a183efb10ab344b53775441",
          "account_id": "57838016001",
          "created_at": "2017-11-24T15:47:07.867Z",
          "name": "places",
          "updated_at": "2017-11-24T15:47:07.867Z",
          "video_count": 0
        },
        {
          "id": "560039f1e4b0e69e4b01cad3",
          "account_id": "57838016001",
          "created_at": "2015-09-21T17:10:09.422Z",
          "name": "water",
          "updated_at": "2015-09-21T17:22:52.935Z",
          "video_count": 7
        }
      ]

Video zum Ordner hinzufügen

Um ein Video zu einem Ordner hinzuzufügen, a PUT Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

Anfrage Körper

Für diesen Vorgang gibt es keinen Anforderungshauptteil.

Antwort

Die Antwort auf diese Anfrage wird sein 204 NO CONTENT.

Entferne das Video aus dem Ordner

Um ein Video aus einem Ordner zu entfernen, a DELETE Anfrage an dieselbe URL, mit der du ein Video hinzufügst:

      https://cms.api.brightcove.com/v1/accounts/account_id/folders/folder_id/videos/video_id

Anfrage Körper

Für diese Anforderung müssen Sie auch den Ordnernamen in den Anfragetext einfügen:

      {
        "name": folder_name
      }

Holen Sie sich Videos in einem Ordner

Um die Videos in einem Ordner abzurufen, a GET Anfrage zu:

      https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos

Parameter anfordern

Standardmäßig gibt diese Anforderung die 20-Videos zurück, die dem Ordner zuletzt hinzugefügt wurden. Sie können dies ändern und die Ergebnisse für einen Ordner durchblättern, der viele Videos enthält, indem Sie der Anforderung einen oder beide der folgenden Parameter hinzufügen:

limit: Die Anzahl der zurückzugebenden Videos (Standard: 20; Maximum: 100)
offset: Die Anzahl der Videos, die übersprungen werden sollen (Standard: 0)

Zum Beispiel gibt diese Anfrage Videos 21-30 der möglichen Ergebnisse zurück (vorausgesetzt, der Ordner enthält so viele Videos):

      https://cms.api.brightcove.com/v1/accounts/:account_id/folders/folder_id/videos?limit=10&offset=20