Überblick: Policy API

In diesem Thema erfahren Sie, was die Policy API ist für und wie man es benutzt. Das Policy API wird zum Erstellen oder Abrufen von Richtlinienschlüsseln verwendet.

Einführung

Unser Richtlinienschlüssel wird zum Abrufen von Video- und Wiedergabelisteninhalten von Ihrem Computer verwendet Video Cloud Bibliothek mit dem Playback API.

Siehe auch die API-Referenz.

Brauchst du einen?

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

Richtlinienschlüssel werden für generiert Brightcove Players automatisch, wenn Sie sie erstellen. Sie müssen Richtlinienschlüssel nur direkt mit dieser API generieren, wenn Sie einen Schlüssel mit Geofilterung für a erhalten möchten playeroder um auf die zuzugreifen Playback API ohne ein zu erstellen player - In der Regel gilt dies für Apps, die mit dem erstellt wurden Geräte-SDKs. Sehen Richtlinienschlüssel Anweisungen zum Beziehen des Richtlinienschlüssels für Brightcove Player.
Video-Suchanfragen ausführen:
- Sie müssen eine verwenden suchaktivierter Richtlinienschlüssel.
- Richtlinienschlüssel für neue generiert Brightcove Players sind nicht standardmäßig aktiviert. Sie müssen dies manuell mit der Taste einstellen Policy API.
- Im Allgemeinen sollten suchfähige Richtlinienschlüssel nur auf einem Server und nicht in einem Browser gespeichert werden player oder mobile App, da sie verwendet werden können, um alle abspielbaren Videos aufzulisten. Für einige Konten gilt dies möglicherweise nicht, wenn Sie nichts dagegen haben, dass alle Ihre abspielbaren Videos entdeckt werden können.
- Suchanfragen geben nur abspielbare Videos zurück. Details zur API-Anfrage / Antwort finden Sie in der Holen Sie sich Videos Abschnitt der Playback API Referenz.

FAQ

Hier sind einige Fragen zur Policy API das wir häufig bekommen.

Können Richtlinienschlüssel für mehrere oder nur einen einzigen Account erstellt werden?: Richtlinienschlüssel ermöglichen den Zugriff auf Videos und Wiedergabelisten für ein Konto. Wenn Sie mehrere Konten haben, müssen Sie Richtlinienschlüssel für jedes Konto erstellen.
Laufen die Richtlinienschlüssel ab?: Nein, Richtlinienschlüssel sind für immer gut. Wenn Sie einen Richtlinienschlüssel widerrufen müssen, müssen Sie sich mit ihm in Verbindung setzen Brightcove Technische Support - Fügen Sie die Konto-ID und den Richtlinienschlüssel hinzu, den Sie in der Anfrage widerrufen möchten.
Funktionieren die Richtlinienschlüssel für alle Benutzer des Kontos?: Ja, jeder, der über den Richtlinienschlüssel verfügt, kann ihn verwenden.
Kann ein Richtlinienschlüssel aktualisiert werden?: Nein, es gibt keine Möglichkeit, einen Richtlinienschlüssel zu aktualisieren. Du kannst entweder Erhalte den Richtlinienschlüssel von einem bestehenden player in Ihrem Video Cloud Konto, oder Sie können einen neuen Richtlinienschlüssel erstellen, indem Sie die Policy API.

Basis-URL

Die Basis-URL für die Policy API ist:

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

Kontopfad

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

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

Beglaubigung

Anforderungen werden von einem Zugriffstoken authentifiziert, das in einem übergeben wird Authorization Header:

    Authorization: Bearer {access_token}

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

Erhalten Sie Ihre Client-Anmeldeinformationen ( client_id und client_secret ) Durch Video Cloud Studio (empfohlen).

Für Zugriffstoken, die mit Anforderungen zum Erstellen von Richtlinienschlüsseln verwendet werden können, müssen Ihre Clientanmeldeinformationen in Studio über die folgenden Berechtigungen verfügen: Players Lesen und Lesen / Schreiben

Authentifizierungsberechtigungen

Sie können die Client - Anmeldeinformationen auch direkt über das Brightcove OAuth API.
Sobald Sie über Client-Anmeldeinformationen verfügen, können Sie dies tun Erhalte temporäre Zugriffstoken von der OAuth API.

Erforderliche Header

Neben der Authorization Header im vorherigen Abschnitt besprochen, Anforderungen müssen auch ein Content-Type Header:

    Content-Type: application/json

Erstellen Sie einen Richtlinienschlüssel

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

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

Anfrage Körper

Fügen Sie im Anfragetext den JSON für die Richtlinie 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 muss mit der Konto-ID in der Anfrage-URL übereinstimmen, andernfalls wird ein Fehler zurückgegeben.

Domänenbeschränkung

Sie können nicht nur den Zugriff auf das Konto beschränken, sondern auch den Zugriff auf bestimmte Domains einschränken, indem Sie das Konto hinzufügen allowed-domains Schlüssel:

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

Domänen müssen das Protokoll und den Domänennamen sowie den Port enthalten, es sei denn, es ist der Standardport für das Protokoll (z. B. http://www.abc.com, https://www.def.com:8888), aber keine Pfade oder Schrägstriche ("/")
Jeder Schlüssel für Ihr Konto kann verwendet werden, um über das Konto auf den Inhalt des Kontos zuzugreifen Playback APIWenn Sie also eine Domainbeschränkung verwenden, empfehlen wir Ihnen dringend, alle Ihre Domains einzuschränken players.
Da die Brightcove Native Player SDKs Senden Sie keinen Ursprungsheader. Sie können keinen domänenbeschränkten Richtlinienschlüssel verwenden. Wenn Sie dies versuchen, erhalten Sie eine 403 Forbidden Antwort, wenn Sie versuchen, Inhalte von Ihrem Computer abzurufen Video Cloud Bibliothek.

Geo-Beschränkung

Unser Policy API kann verwendet werden, um Geofilterung für a zu implementieren player anstelle von oder zusätzlich zu einzelne Videos.

Eine Richtlinie kann die Wiedergabe basierend auf dem vom Nutzer gefundenen Land einschränken. Um einen Schlüssel mit dieser Richtlinie zu erstellen und zu verwenden, muss dem Konto die Verwendung von Geofilterfunktionen gestattet sein. Diese Richtlinie verweigert auch den Zugriff, wenn der Endbenutzer seine Anfrage über einen oder von einem Anonymisierungs-Proxy zu stellen scheint.
Geo-Beschränkungen, die in einem Richtlinienschlüssel angewendet werden, werden erzwungen ausschließlich by players, die diesen Richtlinienschlüssel verwenden.
Geo-Beschränkung kann auch sein auf einzelne Videos angewendet. Video Cloud gilt beides player und Geofilterungsrichtlinien auf Videoebene. Wenn also ein Land von einem der beiden Länder ausgeschlossen wird, ist das Video in diesem Land nicht verfügbar.

Probe

Hier sehen Sie eine Beispiel-Whitelist-Richtliniengruppe, die nur die Wiedergabe aus den USA und den 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 aufzulisten, legen Sie fest exclude_countries zu wahr.

Erfordern SSAI

Wenn Sie mit der serverseitigen Anzeigeneinfügung (SSAI) arbeiten, möchten Sie möglicherweise eine ordnungsgemäße Anzeigenkonfiguration in Ihren API-Anforderungen erzwingen. Sie können dies tun, indem Sie Ihren Richtlinienschlüssel so konfigurieren, dass dies erforderlich ist ad_config_id wird als URL-Parameter an alle angehängt Playback API Anfragen.

Probe

Hier ist ein Beispiel:

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

Einzelheiten zur Verwendung des ad_config_id mit Ihrem Playback API Anfragen finden Sie im Playback API Übersicht: Videoanfrage mit SSAI Dokument.

Videos suchen

Wenn Sie eine Videosuchanforderung ausführen, müssen Sie einen Richtlinienschlüssel verwenden, der für die Suche aktiviert ist. Um einen suchfähigen Richtlinienschlüssel zu erstellen, muss der Anfragetext des Aufrufs Folgendes enthalten:

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

API-Antwort

Die Antwort auf Richtlinienerstellungsanforderungen wird JSON sein, das das Verschlüsselte enthält key-string dass Sie verwenden können, um Anfragen an die zu authentifizieren Playback APIsowie die mit dem Schlüssel verknüpfte Richtlinie:

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

Richtlinienanforderungen

So rufen Sie das Richtlinienobjekt ab, das a zugeordnet ist key-string , 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"
    }

Widerrufen Sie eine Richtlinie

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