Descripción general: API de políticas

Introducción

La clave de política se utiliza para recuperar videos y contenido de listas de reproducción de su biblioteca de Video Cloud usando el API de reproducción.

También vea el 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 para Brightcove Players automáticamente cuando las crea. Solo necesita generar claves de política directamente usando esta API si desea obtener una clave con filtrado geográfico para un reproductor, o acceder a la API de reproducción sin crear un reproductor; normalmente, esto sería para aplicaciones creadas con 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.
• Realización de solicitudes de búsqueda de videos:
  • Debes usar un Clave de política habilitada para búsqueda.
  • Las claves de política generadas para los nuevos reproductores de Brightcove no están habilitadas para la búsqueda de forma predeterminada. Debe configurar esto manualmente usando el API de política.
  • En general, las claves de política 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 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 obtener detalles sobre la solicitud / respuesta de la API, consulte la Obtener videos sección de la Referencia de la API de reproducción.

Preguntas más frecuentes

A continuación, presentamos algunas preguntas sobre la API de políticas que recibimos habitualmente.

URL base

La URL base de la API de políticas es:

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

Ruta de la cuenta

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

Authorization: Bearer {access_token}

Para obtener tokens de acceso, siga estos pasos:

1. Obtenga sus credenciales de cliente ( client_id y client_secret ) mediante Estudio de Video Cloud (recomendado).

   Para los tokens de acceso que se pueden usar con solicitudes de creación de claves de políticas, se requieren sus credenciales de cliente para tener los siguientes permisos en Studio: Los jugadores leen y leen / escriben

   

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

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

Encabezados obligatorios

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

Content-Type: application/json

Crea una clave de política

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

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

Cuerpo de la solicitud

En el cuerpo de la solicitud, incluya el JSON de 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. 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 clave:

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

Restricción geográfica

La API de políticas se puede utilizar para implementar el filtrado geográfico para un jugador en lugar de o además de videos individuales.

Muestra

A continuación, se muestra un ejemplo de conjunto de políticas de lista blanca que solo permite la reproducción desde los EE. UU. Y territorios y bases militares de EE. UU.:

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

Para incluir esos países en la lista negra, establezca exclude_countries a la verdad.

Requerir SSAI

Cuando trabaje con la inserción de anuncios del lado del servidor (SSAI), es posible que desee una forma de hacer cumplir la configuración de anuncios adecuada en sus solicitudes de API. Puede hacer esto configurando su clave de política para requerir que un ad_config_id se agrega como un parámetro de URL a todas las solicitudes de la API de reproducción.

Muestra

He aquí un ejemplo:

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

Para obtener detalles sobre el uso de ad_config_id con sus solicitudes de la API de reproducción, consulte el Descripción general de la API de reproducción: Solicitud de video con SSAI documento.

Buscar videos

Al realizar una solicitud de búsqueda de video, debe utilizar una clave de política que esté habilitada para la búsqueda. Para crear una clave de política habilitada para la búsqueda, 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 políticas será JSON que incluye el cifrado key-string que puede utilizar para autenticar solicitudes a la API de reproducción, así como la política asociada con 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 , haz una solicitud GET a:

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

La respuesta será una representación JSON de la cadena de claves 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 de clave de la política que desea revocar en su solicitud.