Überblick: Richtlinien-API

Einleitung

Die Richtlinienschlüssel wird zum Abrufen von Video- und Playlist-Inhalten aus Ihrer Video Cloud-Bibliothek mit dem Wiedergabe-API.

Siehe auch die API-Referenz.

Brauchen Sie einen?

Es gibt nur Sonderfälle, in denen Sie Ihre eigenen Richtlinienschlüssel generieren müssen:

• Richtlinienschlüssel werden automatisch für Brightcove-Player generiert, wenn Sie sie erstellen. Sie müssen Richtlinienschlüssel nur direkt mit dieser API generieren, wenn Sie einen Schlüssel mit Geofilterung für einen Player erhalten oder auf die Playback-API zugreifen möchten, ohne einen Player zu erstellen – normalerweise ist dies für Apps der Fall, die mit dem erstellt wurden Geräte-SDKs. Sehen Richtlinienschlüssel Anweisungen zum Abrufen des Richtlinienschlüssels für einen beliebigen Brightcove Player.
• Durchführen von Videosuchanfragen:
  • Sie müssen einen Policy Key mit aktivierter Suchfunktion verwenden.
  • Für neue Brightcove-Player generierte Richtlinienschlüssel sind standardmäßig nicht für die Suche aktiviert. Sie müssen dies manuell über die Richtlinien-API.
  • Im Allgemeinen sollten suchaktivierte Richtlinienschlüssel nur auf einem Server und nicht in einem Browserplayer oder einer mobilen App gespeichert werden, da sie zum Auflisten aller abspielbaren Videos verwendet werden können. Für einige Konten gilt dies möglicherweise nicht, wenn es Ihnen nichts ausmacht, dass alle Ihre abspielbaren Videos gefunden werden können.
  • Suchanfragen geben nur abspielbare Videos zurück. Details zu API-Anfragen/-Antworten finden Sie im Videos abrufen Abschnitt der Wiedergabe-API-Referenz.

FAQ

Hier sind einige Fragen zur Richtlinien-API, die wir häufig erhalten.

Basis-URL

Die Basis-URL für die Richtlinien-API lautet:

https://policy.api.brightcove.com/v1

Account-Pfad

In allen Fällen werden Anfragen für ein bestimmtes Video Cloud-Konto gestellt. Sie werden also immer hinzufügen /accounts/ gefolgt von Ihrer Konto-ID zur Basis-URL:

https://policy.api.brightcove.com/v1/accounts/{account_id}

Authentifizierung

Anfragen werden durch ein Zugriffstoken authentifiziert, das in einem übergeben wird Authorization Header:

Authorization: Bearer {access_token}

Gehen Sie folgendermaßen vor, um Zugriffstoken zu erhalten:

1. Besorgen Sie sich Ihre Kundenanmeldeinformationen ( client_id und client_secret ) über Video Cloud Studio (empfohlen).

   Für Zugriffstoken, die mit Anforderungen zum Erstellen von Richtlinienschlüsseln verwendet werden können, müssen Ihre Client-Anmeldeinformationen die folgenden Berechtigungen in Studio haben: Spieler lesen und lesen/schreiben

   

   Sie können Kundendaten auch direkt über das Brightcove OAuth-API.

2. Sobald Sie die Kundendaten haben, können Sie temporäre Zugriffstoken von der OAuth-API abrufen.

Erforderliche Header

In Ergänzung zu Authorization Header, der im vorherigen Abschnitt besprochen wurde, müssen Anforderungen auch ein Content-Type Header:

Content-Type: application/json

Richtlinienschlüssel erstellen

Um einen neuen Richtlinienschlüssel zu erstellen, stellen Sie eine POST-Anfrage an:

https://policy.api.brightcove.com/v1/accounts/{account_id}/policy_keys

Anfragetext

Fügen Sie den JSON-Code für die Richtlinie in den Anforderungstext ein:

{
      "key-data": {
        "account-id": "{account_id}"
      }
    }

Dies ist die grundlegendste Richtlinie, die den Zugriff auf das Konto einschränkt. Sie müssen dies in jede von Ihnen erstellte Richtlinie aufnehmen. Die Konto-ID hier muss mit der Konto-ID in der Anforderungs-URL übereinstimmen. Andernfalls wird ein Fehler zurückgegeben.

Domainbeschränkung

Sie können nicht nur den Zugriff auf das Konto einschränken, sondern auch den Zugriff auf bestimmte Domänen einschränken, indem Sie die allowed-domains Schlüssel:

{
      "key-data": {
        "account-id": "123456789001",
        "allowed-domains": [
          "https://www.abc.com",
          "https://www.abc.com",
          "https://www.xyz.com",
          "https://www.xyz.com"
        ]
      }
    }

Geo-Einschränkung

Die Policy-API kann verwendet werden, um die Geofilterung für einen Player anstelle von oder zusätzlich zu einzelnen Videos zu implementieren.

Probe

Hier ist ein Beispiel für eine Whitelist-Richtlinie, die nur die Wiedergabe aus den USA und US-Territorien und Militärbasen zulässt:

{"account-id": "8523232323",
      "geo": {
        "countries": ["us", "usmil", "pr", "gu", "vi", "as", "mp"],
        "exclude_countries": false
      }
    }

Um diese Länder stattdessen auf die schwarze Liste zu setzen, setzen Sie exclude_countries zu wahr.

SSAI erforderlich

Wenn Sie mit Server-Side Ad Insertion (SSAI) arbeiten, möchten Sie möglicherweise die richtige Anzeigenkonfiguration in Ihren API-Anfragen erzwingen. Sie können dies tun, indem Sie Ihren Richtlinienschlüssel so konfigurieren, dass ein ad_config_id wird als URL-Parameter an alle Playback-API-Anforderungen angehängt.

Probe

Hier ist ein Beispiel:

{
      "key-data": {
        "account-id": "1752604059001",
        "require-ad-config": true
      }
    }

Einzelheiten zur Verwendung des ad_config_id Informationen zu Ihren Playback API-Anfragen finden Sie im Übersicht über die Wiedergabe-API: Videoanfrage mit SSAI dokumentieren.

Videos suchen

Wenn Sie eine Videosuchanfrage ausführen, müssen Sie einen Richtlinienschlüssel verwenden, der für die Suche aktiviert ist. Um einen suchaktivierten Richtlinienschlüssel zu erstellen, muss der Anforderungstext des Aufrufs Folgendes enthalten:

{
      "key-data": {
        "account-id": "57838016001",
        "apis": ["search"]
      }
    }

API-Antwort

Die Antwort auf Anfragen zur Erstellung von Richtlinien ist JSON, das die verschlüsselte Version enthält key-string , mit der Sie Anfragen an die Playback-API authentifizieren können, sowie die dem Schlüssel zugeordnete Richtlinie:

{
      "key-data": {
        "account-id": "57838016001"
      },
      "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
    }

Richtlinienanfragen

Um das mit einem verknüpfte Richtlinienobjekt abzurufen key-string , senden Sie eine GET-Anfrage an:

/accounts/v1/{account_id}/policy_keys/{key_string}

Die Antwort ist eine JSON-Darstellung der Schlüsselzeichenfolge und der Richtlinie:

{
      "key-data": {
        "account-id": "57838016001"
      },
      "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
    }

Widerruf einer Richtlinie

Wenn Sie eine bestehende Richtlinie widerrufen müssen, senden Sie eine Anfrage an Brightcove-Support. Fügen Sie die Schlüsselzeichenfolge für die Richtlinie in Ihre Anfrage ein, die Sie widerrufen möchten.