Paper Contacter le support | état du système L'état du système
Contenu de la page

    Aperçu: Policy API

    Dans ce sujet, vous apprendrez ce que le Policy API est pour et comment l'utiliser. le Policy API est utilisé pour créer ou obtenir des clés de stratégie.

    Introduction

    Le système clé de politique est utilisé pour récupérer le contenu de vidéos et de listes de lecture de votre Video Cloud bibliothèque utilisant le Playback API.

    Voir aussi le Référence de l'API.

    Avez-vous besoin d'un?

    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 politique sont générées pour Brightcove Players automatiquement lorsque vous les créez. Vous devez uniquement générer des clés de stratégie directement à l'aide de cette API si vous souhaitez obtenir une clé avec géofiltrage pour un player, ou pour accéder à Playback API sans créer un player - ce serait généralement pour les applications créées à l'aide du SDK de l'appareil. Voir Clés de stratégie pour savoir comment obtenir la clé de politique pour Brightcove Player.
    • Effectuer des recherches vidéo:
      • Vous devez utiliser un clé de stratégie activée par la recherche.
      • Clés de stratégie générées pour les nouveaux Brightcove PlayerLa recherche n'est pas activée par défaut. Vous devez régler ceci manuellement en utilisant le bouton Policy API.
      • 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 navigateur player ou application mobile, car ils peuvent être utilisés pour répertorier toutes les vidéos lisibles. Pour certains comptes, cela peut ne pas s'appliquer si cela ne vous dérange pas que toutes vos vidéos lisibles puissent être découvertes.
      • Les demandes de recherche ne renvoient que des vidéos lisibles. Pour les détails de demande / réponse d'API, consultez la Obtenez des vidéos l'article de l' Playback API Référence.

    QFP

    Voici quelques questions sur le Policy API que nous obtenons couramment.

    Est-il possible de créer des clés de stratégie pour plusieurs comptes ou un seul?
    Les clés de stratégie autorisent l'accès aux vidéos et aux listes de lecture pour un compte. Si vous avez plusieurs comptes, vous devez créer des clés de stratégie pour chacun d'entre eux.
    Les clés de stratégie expirent-elles?
    Non, les clés de politique sont bonnes pour toujours. Si vous devez révoquer une clé de police, vous devez contacter Prise en charge de Brightcove - inclure l'identifiant du compte et la clé de politique que vous souhaitez révoquer dans la demande.
    Les clés de stratégie fonctionnent-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'y a aucun moyen de mettre à jour une clé de stratégie. Tu peux soit obtenir la clé de la politique à partir d'un existant player dans votre Video Cloud compte, ou vous pouvez créer une nouvelle clé de stratégie en utilisant le Policy API.

    URL de base

    L'URL de base pour le Policy API est:

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

    Chemin du compte

    Dans tous les cas, des demandes seront faites pour un Video Cloud 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 transmis dans un Authorization en-tête:

        Authorization: Bearer {access_token}

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

    1. Obtenez vos informations d'identification client ( client_id et client_secret ) À travers Video Cloud Studio (conseillé).

      Pour les jetons d'accès pouvant être utilisés avec des demandes de création de clé de stratégie, vos informations d'identification client doivent disposer des autorisations suivantes dans Studio: Players Lire et lire / écrire

      Autorisations d'authentification
      Autorisations d'authentification

      Vous pouvez également obtenir les informations d'identification du client directement via le Brightcove OAuth API.

    2. Une fois que vous disposez des informations d'identification du client, vous pouvez obtenir des jetons d'accès temporaire à partir du OAuth API.

    En-têtes requis

    En plus de la Authorization l’en-tête discuté dans la section précédente, les demandes doivent aussi avoir un Content-Type en-tê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

    Demander un corps

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

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

    C'est la politique la plus basique, qui limite 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 requête, 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 allowed-domains clé:

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

    Restriction géographique

    Le système Policy API peut être utilisé pour implémenter le géofiltrage pour un player au lieu ou en plus de vidéos individuelles.

    Échantillon

    Voici un exemple de jeu de règles de liste blanche qui autorise uniquement la lecture 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, définissez exclude_countries à vrai.

    Exiger SSAI

    Lorsque vous travaillez avec l'insertion d'annonce 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 à tous Playback API demandes.

    É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 votre Playback API demandes, voir le Playback API Vue d'ensemble: demande de vidéo avec SSAI document.

    Rechercher des vidéos

    Lorsque vous effectuez une recherche vidéo, vous devez utiliser une clé de stratégie activée pour la recherche. Pour créer une clé de stratégie activée pour la 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 chiffré key-string que vous pouvez utiliser pour authentifier les requêtes auprès du Playback API, ainsi que la politique associée à la clé:

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

    Demandes de politique

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

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

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

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

    Révoquer une politique

    Si vous devez révoquer une politique existante, envoyez une demande à Prise en charge de Brightcove. Incluez la chaîne de clé pour la stratégie que vous souhaitez révoquer dans votre demande.


    Dernière mise à jour de la page le 12 juin 2020