assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Présentation : API Policy

    Dans cette rubrique, vous apprendrez à quoi sert l'API de stratégie et comment l'utiliser. L'API de stratégie est utilisée pour créer ou obtenir des clés de stratégie.
     

    Introduction

    La clé de stratégie permet de récupérer du contenu vidéo et de liste de lecture de votre bibliothèque Video Cloud à l'aide de l' API Lecture.

    Voir également la référence de l'API.

    Vous en avez 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 joueurs Brightcove lorsque vous les créez. Vous n'avez besoin de générer des clés de stratégie directement à l'aide de cette API que si vous souhaitez obtenir une clé avec géo-filtrage 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 des kits SDK de périphérique. Consultez les clés de stratégie pour obtenir des instructions sur l'obtention de la clé de stratégie pour n'importe quel lecteur Brightcove.
    • Exécution de demandes de recherche vidéo :
      • Vous devez utiliser une clé de stratégie activée pour la recherche.
      • Les clés de stratégie générées pour les nouveaux joueurs Brightcove ne sont pas activées par défaut. Vous devez définir cette option manuellement à l'aide de l' API de stratégie.
      • 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 lister toutes les vidéos jouables. Pour certains comptes, cela peut ne pas s'appliquer si vous ne vous dérangez pas que toutes vos vidéos jouables puissent être découvertes.
      • Les demandes de recherche ne renverront que les vidéos jouables. Pour plus d'informations sur la demande/réponse d'API, reportez-vous à la section Obtenir des vidéos de la référence de l'API de lecture.

    FAQ

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

    Peut-on créer des clés de stratégie pour plusieurs comptes, ou un seul ?
    Les clés de stratégie permettent l'accès aux vidéos et aux listes de lecture pour un compte. Si vous disposez de plusieurs comptes, vous devez créer des clés de stratégie pour chacun d'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 stratégie, vous devez contacter le support Brightcove - inclure l'ID du compte et la clé de stratégie que vous souhaitez révoquer dans la demande.
    Les clés de stratégie fonctionnent-elles pour tous les utilisateurs du compte ?
    Oui, tous ceux qui ont la clé de politique peuvent 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. Vous pouvez soit obtenir la clé de stratégie à partir d'un lecteur existant dans votre compte Video Cloud, soit créer une nouvelle clé de stratégie à l'aide de l'API Policy.

    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 compte Video Cloud spécifique. Ainsi, 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 ) via Video Cloud Studio (recommandé).

      Pour les jetons d'accès qui peuvent ê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 : Lecture et lecture/écriture

      Autorisations d'authentification
      Autorisations d'authentification

      Vous pouvez également obtenir des informations d'identification client directement via l' API Brightcove OAuth.

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

    En-têtes obligatoires

    En plus de l' Authorization en-tête discuté dans la section précédente, les requêtes doivent également 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, effectuez une requête POST pour :

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

    Corps de la requête

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

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

    Il s'agit de la stratégie la plus élémentaire, qui restreint l'accès au compte, vous devez l'inclure dans toute stratégie 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 du domaine

    En plus de limiter l'accès au compte, vous pouvez également limiter l'accès à des domaines spécifiques en ajoutant la 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éo

    L'API Policy peut être utilisée pour implémenter le géo-filtrage pour un lecteur au lieu ou en plus de vidéos individuelles.

    Exemple

    Voici un exemple de stratégie de liste blanche qui autorise uniquement la lecture depuis les territoires et bases militaires des États-Unis et des États-Unis :

        {"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 la valeur true.

    Exiger SSAI

    Lorsque vous travaillez avec l'insertion d'annonces côté serveur (SSAI), vous voudrez 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 paramètre d'URL ad_config_id soit ajouté à toutes les requêtes d'API de lecture.

    Exemple

    Voici un exemple :

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

    Pour plus d'informations sur l'utilisation du ad_config_id avec vos demandes d'API de lecture, reportez-vous à la section Présentation de l'API de lecture : Demande vidéo avec document SSAI .

    Rechercher vidéos

    Lorsque vous effectuez une demande de recherche vidéo, vous devez utiliser une clé de stratégie qui est 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 à l'API de lecture, ainsi que la stratégie 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 , effectuez 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 stratégie :

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

    Révoquer une stratégie

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