soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Resumen: Policy API

    En este tema, aprenderá para qué sirve la API de directivas y cómo usarla. La API de directivas se utiliza para crear u obtener claves de política.
     

    Introducción

    La clave de directiva se utiliza para recuperar contenido de vídeo y lista de reproducción de la biblioteca de Video Cloud mediante la API de reproducción.

    Consulte también la Referencia de API.

    ¿Necesitas uno?

    Solo hay casos especiales en los que necesita generar sus propias claves de política:

    • Las claves de política se generan automáticamente para los reproductores de Brightcove cuando se crean. Solo necesita generar claves de política directamente usando esta API si desea obtener una clave con geo-filtrado para un reproductor, o para acceder a la API de reproducción sin crear un reproductor, normalmente esto sería para aplicaciones creadas con los SDK del dispositivo. Consulte Claves de política para obtener instrucciones sobre cómo obtener la clave de política para cualquier reproductor de Brightcove.
    • Realización de solicitudes de búsqueda de vídeo:
      • Debe utilizar una clave de directiva habilitada para la búsqueda.
      • Las claves de directiva generadas para los nuevos jugadores de Brightcove no están activadas de forma predeterminada. Debe configurarlo manualmente mediante la API de directivas.
      • En general, las claves de directiva habilitadas para la búsqueda solo deben almacenarse en un servidor y no en un reproductor de navegador o aplicación móvil, ya que pueden utilizarse para enumerar todos los vídeos reproducibles. En algunas cuentas esto puede no ser aplicable si no te importa que se puedan descubrir todos los vídeos reproducibles.
      • Las solicitudes de búsqueda solo devolverán vídeos reproducibles. Para obtener detalles de solicitud/respuesta de API, consulte la sección Obtener vídeos de la Referencia de la API de reproducción.

    Preguntas frecuentes (FAQ)

    Estas son algunas preguntas acerca de la API de políticas que normalmente obtenemos.

    ¿Se pueden crear claves de política para varias cuentas, o solo una?
    Las teclas de directiva permiten el acceso a vídeos y listas de reproducción de una cuenta. Si tiene varias cuentas, debe crear claves de directiva para cada una.
    ¿Caducan las claves de política?
    No, las claves de política son buenas para siempre. Si necesita revocar una clave de política, debe ponerse en contacto con el servicio de soporte de Brightcove . Incluya el ID de cuenta y la clave de política que desea revocar en la solicitud.
    ¿Funcionarán las claves de política para todos los usuarios de la cuenta?
    Sí, cualquiera que tenga la clave de política puede usarla.
    ¿Se puede actualizar una clave de política?
    No, no hay forma de actualizar una clave de política. Puede obtener la clave de directiva de un reproductor existente en su cuenta de Video Cloud o crear una nueva clave de directiva mediante la API de directivas.

    URL base

    La dirección URL base para la API de directivas es:

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

    Ruta de la cuenta

    En todos los casos, se solicitarán una cuenta de Video Cloud específica. Por lo tanto, siempre agregará /accounts/ seguido de su ID de cuenta a la URL base:

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

    Autenticación

    Las solicitudes se autentican mediante un token de acceso pasado en un Authorization encabezado:

        Authorization: Bearer {access_token}

    Para obtener tokens de acceso, siga estos pasos:

    1. Obtenga sus credenciales de cliente ( client_id y client_secret ) a través de Video Cloud Studio (recomendado).

      Para los tokens de acceso que se pueden utilizar con solicitudes de creación de claves de directiva, las credenciales de cliente deben tener los siguientes permisos en Studio: Jugadores Leer y Lectura/Escritura

      Autorizaciones de autenticación
      Autorizaciones de autenticación

      También puede obtener las credenciales de cliente directamente a través de la API OAuth de Brightcove.

    2. Una vez que tenga credenciales de cliente, puede obtener tokens de acceso temporales desde la API de OAuth.

    Encabezados requeridos

    Además del Authorization encabezado discutido en la sección anterior, las solicitudes también deben tener un Content-Type encabezado:

        Content-Type: application/json

    Crear una clave de directiva

    Para crear una nueva clave de política, realice una solicitud POST a:

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

    Cuerpo de solicitud

    En el cuerpo de solicitud, incluya el JSON para la política:

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

    Esta es la política más básica, que restringe el acceso a la cuenta, debe incluirla en cualquier política que cree. El ID de cuenta aquí debe coincidir con el ID de cuenta en la URL de solicitud o se devolverá un error.

    Restricciones de dominios

    Además de limitar el acceso a la cuenta, también puede limitar el acceso a dominios específicos agregando la allowed-domains clave:

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

    Restricción geográfica

    La API de directivas se puede utilizar para implementar el geo-filtrado para un reproductor en lugar de vídeos individuales o además de ellos.

    Ejemplo

    Aquí hay un ejemplo de conjunto de políticas de lista blanca que solo permite la reproducción desde los territorios y bases militares de Estados Unidos y Estados Unidos:

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

    Para poner en la lista negra a esos países en su lugar, exclude_countries establecer en true.

    Requerir SSAI

    Cuando trabaje con Inserción de anuncios en el lado del servidor (SSAI), es posible que desee una forma de aplicar la configuración de anuncios adecuada en las solicitudes de API. Puede hacerlo configurando la clave de directiva para requerir que ad_config_id se añada un parámetro URL a todas las solicitudes de la API de reproducción.

    Ejemplo

    Un ejemplo:

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

    Para obtener más información sobre el uso de ad_config_id con las solicitudes de API de reproducción, consulte la descripción general de la API de reproducción: Solicitud de vídeo con documento SSAI .

    Buscar vídeos

    Al realizar una solicitud de búsqueda de vídeo, debe utilizar una clave de directiva que esté habilitada para la búsqueda. Para crear una clave de directiva habilitada para búsquedas, el cuerpo de la solicitud de la llamada debe incluir lo siguiente:

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

    Respuesta de API

    La respuesta a las solicitudes de creación de directivas será JSON que incluye el cifrado key-string que puede utilizar para autenticar solicitudes en la API de reproducción, así como la directiva asociada a la clave:

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

    Solicitudes de directiva

    Para recuperar el objeto de directiva asociado a un key-string , realice una solicitud GET a:

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

    La respuesta será la representación JSON de la cadena clave y la política:

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

    Revocar una política

    Si necesita revocar una política existente, envíe una solicitud al Soporte técnico de Brightcove. Incluya la cadena clave de la política que desea revocar en su solicitud.


    Última actualización de la página el 28-09-2020