Aperçu: API de règles

Introduction

Les clé de stratégie est utilisé pour récupérer le contenu vidéo et de liste de lecture de votre bibliothèque Video Cloud en utilisant le API de lecture.

Voir aussi le Référence API.

En avez-vous besoin ?

Il n'y a que des cas particuliers où vous devez générer vos propres clés de stratégie :

Les clés de stratégie sont générées automatiquement pour les lecteurs Brightcove lorsque vous les créez. Vous n'avez besoin de générer des clés de politique directement à l'aide de cette API que si vous souhaitez obtenir une clé avec filtrage géographique pour un lecteur, ou accéder à l'API de lecture sans créer de lecteur - ce serait généralement pour les applications créées à l'aide du SDK de périphérique. Voir Clés de stratégie pour obtenir des instructions sur la façon d'obtenir la clé de stratégie pour n'importe quel Brightcove Player.
Exécution des requêtes de recherche de vidéos :
- Vous devez utiliser un Clé de stratégie activée pour la recherche.
- Les clés de stratégie générées pour les nouveaux lecteurs Brightcove ne sont pas activées par défaut pour la recherche. Vous devez le régler manuellement à l'aide de la API de règles.
- En général, les clés de stratégie activées pour la recherche ne doivent être stockées que sur un serveur et non dans un lecteur de navigateur ou une application mobile, car elles peuvent être utilisées pour répertorier toutes les vidéos lisibles. Pour certains comptes, cela peut ne pas être applicable si cela ne vous dérange pas que toutes vos vidéos jouables puissent être découvertes.
- Les demandes de recherche ne renverront que des vidéos jouables. Pour plus de détails sur les requêtes/réponses de l'API, consultez le Obtenir des vidéos partie de la Référence de l'API de lecture.

FAQ

Voici quelques questions sur l'API Policy que nous recevons couramment.

Les clés de stratégie peuvent-elles être créées pour plusieurs comptes ou pour un seul ?

Les clés de stratégie permettent d'accéder aux vidéos et à la liste de lecture pour un seul compte. Si vous avez plusieurs comptes, vous devez créer des clés de stratégie pour chacun.

Les clés de stratégie expirent-elles ?

Non, les clés de stratégie sont valables pour toujours. Si vous devez révoquer une clé de stratégie, vous devez contacter Assistance Brightcove - incluez l'identifiant du compte et la clé de stratégie que vous souhaitez révoquer dans la demande.

Les clés de stratégie fonctionneront-elles pour tous les utilisateurs du compte ?

Oui, toute personne disposant de la clé de stratégie peut l'utiliser.

Une clé de stratégie peut-elle être mise à jour ?

Non, il n'existe aucun moyen de mettre à jour une clé de stratégie. Tu peux soit obtenir la clé de la politique à partir d'un lecteur existant dans votre compte Video Cloud, ou vous pouvez créer une nouvelle clé de politique en utilisant l'API de politique.

URL de base

L'URL de base de l'API Policy est :

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

Chemin du compte

Dans tous les cas, des demandes seront faites pour un Nuage vidéo Compte. Donc, vous ajouterez toujours /accounts/ suivi de votre identifiant de compte à l'URL de base :

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

Authentification

Les demandes sont authentifiées par un jeton d'accès passé dans un Authorization entête:

Authorization: Bearer {access_token}

Pour obtenir des jetons d'accès, procédez comme suit :

Obtenez vos identifiants client ( client_id et client_secret ) par Studio Nuage Vidéo (conseillé).

Pour les jetons d'accès pouvant être utilisés avec les demandes de création de clé de stratégie, vos identifiants client doivent disposer des autorisations suivantes dans Studio : Les joueurs lisent et lisent/écrivent

Autorisations d'authentification

Vous pouvez également obtenir les informations d'identification du client directement via le API Brightcove OAuth.
Une fois que vous avez les informations d'identification du client, vous pouvez obtenir des jetons d'accès temporaires à partir de l'API OAuth.

En-têtes obligatoires

En plus de Authorization en-tête discuté dans la section précédente, les demandes doivent également avoir un Content-Type entête:

Content-Type: application/json

Créer une clé de stratégie

Pour créer une nouvelle clé de stratégie, envoyez une requête POST à :

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

Corps de la demande

Dans le corps de la requête, incluez le JSON de la stratégie :

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

Il s'agit de la politique la plus basique, qui restreint l'accès au compte, vous devez l'inclure dans toute politique que vous créez. L'identifiant du compte ici doit correspondre à l'identifiant du compte dans l'URL de la demande, sinon une erreur sera renvoyée.

Restriction de domaine

En plus de limiter l'accès au compte, vous pouvez également limiter l'accès à des domaines spécifiques en ajoutant le allowed-domains clé:

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

Les domaines doivent contenir le protocole et le nom de domaine, ainsi que le port, sauf s'il s'agit du port par défaut pour le protocole (par exemple https://www.abc.com, https://www.def.com:8888), mais pas les chemins d'accès ni les barres obliques ("/")
N'importe quelle clé de votre compte peut être utilisée pour accéder au contenu du compte via l'API de lecture, donc si vous utilisez la restriction de domaine, nous vous recommandons fortement de restreindre le domaine de tous vos joueurs.
Parce que le Kits de développement logiciel (SDK) Brightcove Native Player n'envoyez pas d'en-tête d'origine, vous ne pouvez pas utiliser une clé de stratégie restreinte au domaine. Si vous essayez ceci, vous obtiendrez un 403 Forbidden réponse lorsque vous essayez de récupérer du contenu dans votre bibliothèque Video Cloud.

Restriction géographique

L'API Policy peut être utilisée pour mettre en œuvre un filtrage géographique pour un joueur à la place ou en plus de vidéos individuelles.

Une règle peut restreindre la lecture en fonction du pays détecté par le spectateur. Pour créer et utiliser une clé avec cette politique, le compte doit être autorisé à utiliser les fonctionnalités de filtrage géographique. Cette politique refusera également l'accès si l'utilisateur final semble faire sa demande via ou à partir d'un proxy d'anonymisation.
Les restrictions géographiques appliquées dans une clé de stratégie sont appliquées seul par les joueurs qui utilisent cette clé de politique.
La géo-restriction peut également être appliqué à des vidéos individuelles. Video Cloud applique à la fois des politiques de géo-filtrage au niveau du lecteur et de la vidéo, donc si un pays est exclu par l'un ou l'autre, la vidéo ne sera pas disponible dans ce pays.

échantillon

Voici un exemple d'ensemble de règles de liste blanche qui n'autorise la lecture qu'à partir des territoires américains et américains et des bases militaires :

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

Pour mettre ces pays sur liste noire à la place, définissez exclude_countries à vrai.

Exiger la SSAI

Lorsque vous travaillez avec l'insertion d'annonces côté serveur (SSAI), vous souhaiterez peut-être un moyen d'appliquer une configuration d'annonce appropriée dans vos demandes d'API. Vous pouvez le faire en configurant votre clé de stratégie pour exiger qu'un ad_config_id est ajouté en tant que paramètre d'URL à toutes les requêtes de l'API de lecture.

échantillon

Voici un exemple :

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

Pour plus de détails sur l'utilisation du ad_config_id avec vos requêtes d'API Playback, consultez le Présentation de l'API de lecture : Demande de vidéo avec SSAI document.

Rechercher des vidéos

Lors de l'exécution d'une demande de recherche de vidéo, vous devez utiliser une clé de stratégie activée pour la recherche. Pour créer une clé de stratégie de recherche, le corps de la demande de l'appel doit inclure les éléments suivants :

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

Réponse de l'API

La réponse aux demandes de création de stratégie sera JSON qui inclut le chiffrement key-string que vous pouvez utiliser pour authentifier les requêtes à l'API Playback, ainsi que la politique associée à la clé :

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

Demandes de stratégie

Pour récupérer l'objet de stratégie associé à un key-string , envoyez une requête GET à :

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

La réponse sera une représentation JSON de la chaîne de clé et de la stratégie :

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

Révoquer une politique

Si vous devez révoquer une politique existante, soumettez une demande à Assistance Brightcove. Incluez la chaîne de clé de la stratégie que vous souhaitez révoquer dans votre demande.