soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Características: Policy API

    En este tema, usted aprenderá lo que el Policy API es para y como usarlo. los Policy API Se utiliza para crear u obtener claves de política.
     

    Introducción

    El clave de política se utiliza para recuperar el contenido del video y la lista de reproducción de su Video Cloud biblioteca utilizando el Playback API.

    Ver también el Referencia de la API.

    ¿Necesitas uno?

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

    • Se generan claves de política para Brightcove Players automáticamente cuando los creas. Solo necesita generar claves de política directamente utilizando esta API si desea obtener una clave con filtro geográfico para un playero para acceder a Playback API sin crear un player - normalmente esto sería para aplicaciones creadas usando el SDK del dispositivo. Ver Claves de política Para obtener instrucciones sobre cómo obtener la clave de política para cualquier Brightcove Player.
    • Realizar solicitudes de búsqueda de video:
      • Debes usar un clave de política habilitada para búsqueda.
      • Claves de políticas generadas para nuevos. Brightcove Players no están habilitados para la búsqueda por defecto. Debes configurarlo manualmente usando el Policy API.
      • En general, las claves de políticas habilitadas para búsqueda solo deben almacenarse en un servidor y no en un navegador player o aplicación móvil, ya que se pueden usar para enumerar todos los videos reproducibles. Para algunas cuentas, esto puede no ser aplicable si no le importa que se puedan descubrir todos sus videos reproducibles.
      • Las solicitudes de búsqueda solo devolverán videos reproducibles. Para detalles de solicitud / respuesta de API, vea el Obtener videos sección de la Playback API Referencia.

    Preguntas Frecuentes

    Aquí hay algunas preguntas sobre el Policy API que comúnmente obtenemos.

    ¿Se pueden crear claves de política para varias cuentas, o solo una?
    Las claves de política permiten el acceso a videos y listas de reproducción para una cuenta. Si tiene varias cuentas, necesita crear claves de política para cada una.
    ¿Las claves de política caducan?
    No, las claves de política son buenas para siempre. Si necesita revocar una clave de política, debe contactar Soporte de Brightcove - incluya la identificación de la 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. Tu también puedes obtener la clave de política de un existente player en su Video Cloud cuenta, o puede crear una nueva clave de política utilizando el Policy API.

    URL base

    La URL base para el Policy API es:

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

    Ruta de cuenta

    En todos los casos, las solicitudes se realizarán para un Video Cloud Cuenta. Por lo tanto, siempre agregará /accounts/ seguido de su identificación 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 una Authorization encabezamiento:

        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 Video Cloud Estudio (recomendado).

      Para los tokens de acceso que se pueden usar con las solicitudes de creación de claves de política, se requieren las credenciales de los clientes para tener los siguientes permisos en Studio: Players Leer y leer / escribir

      Permisos de autenticación
      Permisos de autenticación

      También puede obtener credenciales del cliente directamente a través del Brightcove OAuth API.

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

    Encabezados requeridos

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

        Content-Type: application/json

    Crear una clave de política

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

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

    Solicitar cuerpo

    En el cuerpo de la 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 incluir esto en cualquier política que cree. La identificación de la cuenta aquí debe coincidir con la identificación de la cuenta en la URL de la solicitud, o se devolverá un error.

    Restricción de dominio

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

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

    Geo restricción

    El Policy API se puede usar para implementar el filtrado geográfico para un player en lugar de o además de videos individuales

    Muestra

    Aquí hay un conjunto de políticas de ejemplo de la lista blanca que solo permite la reproducción desde los territorios de EE. UU. Y EE. UU. Y las bases militares:

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

    Para poner en una lista negra a esos países, establezca exclude_countries a la verdad

    Requerir SSAI

    Al trabajar 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 sus solicitudes API. Puede hacer esto configurando su clave de política para requerir que ad_config_id Se adjunta como un parámetro de URL a todos Playback API peticiones.

    Muestra

    Aquí hay un ejemplo:

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

    Para detalles sobre el uso del ad_config_id con tu Playback API peticiones, ver el Playback API Resumen: Solicitud de video con SSAI documento.

    Buscar videos

    Al realizar una solicitud de búsqueda de video, debe usar una clave de política que esté habilitada para búsqueda. Para crear una clave de política habilitada para búsqueda, el cuerpo de la solicitud de la llamada debe incluir lo siguiente:

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

    Respuesta API

    La respuesta a las solicitudes de creación de políticas será JSON que incluye el cifrado key-string que puede utilizar para autenticar solicitudes al Playback API, así como la política asociada a la clave:

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

    Solicitudes de política

    Para recuperar el objeto de política asociado con un key-string , haga 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 a Soporte de Brightcove. Incluya la cadena clave para la política que desea revocar en su solicitud.


    Página actualizada por última vez el 28 Sep 2020