Usar API de autenticación

Introducción

Brightcove Playback Restrictions ofrece un nivel adicional de seguridad cuando se utiliza Dynamic Delivery con contenido protegido por DRM o HTTP Live Streaming Encryption (HLSe).

Si no está familiarizado con esta función, consulte la descripción general: Documento de restricciones de reproducción de Brightcove.

Estas son las API disponibles para administrar la protección de claves / licencias:

Registrar clave pública
Fichas de lista negra
Auditar una cuenta

Registrar clave pública

Eres propietario de la clave privada y la usarás para generar tokens firmados. Compartirá la clave pública con Brightcove para verificar sus tokens. La API de claves le permite registrar su clave pública con Brightcove.

API clave

La API de claves se utiliza para administrar sus claves públicas con Brightcove.

URL base

La URL base de la API es:

https://playback-auth.api.brightcove.com

Ruta de la cuenta

En todos los casos, las solicitudes se realizarán para un Video Cloud Cuenta. Por lo tanto, siempre agregará el término cuentas seguido de la identificación de su cuenta a la URL base:

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}

Autorización

Se requiere un token de acceso para las solicitudes y debe estar presente en el encabezado de Autorización:

Authorization: Bearer {access_token}

El token de acceso es un token de acceso OAuth2 temporal que debe obtenerse del servicio Brightcove OAuth. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Permisos

Las solicitudes a la API clave deben realizarse desde credenciales del cliente con los siguientes permisos:

video-cloud/playback-auth/key/read
video-cloud/playback-auth/key/write

Administrar claves

La API clave admite las siguientes solicitudes:

Registre una nueva clave:

Pon el valor de tu clave pública en el cuerpo de la solicitud de API. Puede encontrar la clave en el public_key.txt expediente.

Solicitud de API

POST /v1/accounts/{accountID}/keys
    Content-Type: application/json
    Body: {"value": "MFkwEwYHKoZIzj0CAQYIKoZIzj...MyeQviqploA=="}

Usando Curl

curl -X POST \\
    -H "Tipo de contenido: aplicación / json" \\
    -H "Autorización: Portador {access_token} "\\
    -d '{"value": "{your_public_key_value}"}' \\
  https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/keys

Respuesta de API

{
    "id": "{your_public_key_id}",
    "type": "public",
    "algorithm": "rsa",
    "value": "{your_public_key_value}",
    "createdAt": "2020-01-03T20:30:36.488Z"
  }

Lista de claves:

Obtenga una lista de claves públicas en su cuenta.

GET /v1/accounts/{accountID}/keys

Obtenga una clave:

Obtenga los detalles de una clave pública en su cuenta.

GET /v1/accounts/{accountID}/keys/{key_Id}

Eliminar una clave:

Elimina una clave pública de tu cuenta.

DELETE /v1/accounts/{accountID}/keys/{key_Id}

Fichas de lista negra

Un token que se haya incluido en la lista negra no se considerará válido para solicitudes de licencia, incluso si de otro modo hubiera sido aprobado. Los clientes pueden incluir hasta 100 tokens en la lista negra. Si 100 tokens ya están en la lista negra, el cliente debe eliminar uno o más tokens para dejar espacio para entradas adicionales.

API de lista negra

La API de lista negra se utiliza para administrar sus tokens que están en la lista negra y se consideran no válidos para solicitudes de licencia.

URL base

La URL base de la API de lista negra es:

https://playback-auth.api.brightcove.com

Ruta de la cuenta

En todos los casos, las solicitudes se realizarán para un Video Cloud Cuenta. Por lo tanto, siempre agregará el término cuentas seguido de la identificación de su cuenta a la URL base:

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/blacklist

Autorización

Se requiere un token de acceso para las solicitudes y debe estar presente en el encabezado de Autorización:

Authorization:  Bearer  {access_token}

El token de acceso es un token de acceso OAuth2 temporal que debe obtenerse del servicio Brightcove OAuth. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Permisos

Las solicitudes a la API de lista negra deben realizarse desde credenciales del cliente con los siguientes permisos:

video-cloud/playback-auth/blacklist

Administrar tokens incluidos en la lista negra

Las actualizaciones de la lista negra pueden tardar hasta un minuto en propagarse por el sistema. La API de lista negra admite las siguientes solicitudes:

Agregue un token a la lista negra:

PUT  (no  req  body)/v1/accounts/{accountID}/blacklist/tokens/{token}

Toda la cadena JWT codificada se incluye en la ruta.

Mostrar lista negra actual:

GET  /v1/accounts/{accountId}/blacklist

Compruebe si un token está en la lista negra:

GET  /v1/accounts/{accountID}/blacklist/tokens/{token}

Toda la cadena JWT codificada se incluye en la ruta.

Respuestas:

204 - el token está en la lista negra
404: el token no está en la lista negra

Eliminar un token de la lista negra:

DELETE  /v1/accounts/{accountID}/blacklist/tokens/{token}

Toda la cadena JWT codificada se incluye en la ruta.

Auditar una cuenta

La API de auditoría le permite generar un informe de acceso diario para el uso del Servicio de autorización de reproducción de su cuenta. Este informe incluye detalles junto con la respuesta de autorización para cada sesión.

API de auditoría

A continuación, se muestran los detalles de la API de auditoría:

URL base

La URL base de la API de auditoría es:

https://playback-auth.api.brightcove.com

Ruta de la cuenta

En todos los casos, las solicitudes se realizarán para una cuenta de Video Cloud específica. Por lo tanto, siempre agregará el término cuentas seguido de la identificación de su cuenta a la URL base:

https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}

Autorización

Se requiere un token de acceso para las solicitudes y debe estar presente en el encabezado de Autorización:

Authorization:  Bearer  {access_token}

El token de acceso es un token de acceso OAuth2 temporal que debe obtenerse del servicio Brightcove OAuth. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Permisos

Las solicitudes a la API de auditoría deben realizarse desde credenciales del cliente con los siguientes permisos:

video-cloud/playback-auth/audit

Generar informes

Utilice la API de auditoría para generar un informe de acceso diario con los detalles de la sesión siguiendo estos pasos:

Notas:

Todos los registros de acceso de autorización para Brightcove se encuentran en la zona horaria UTC. Recuerde tener en cuenta las zonas horarias cuando las solicitudes no aparezcan en su informe.
Brightcove recomienda ejecutar informes de consultas de la API de auditoría 6 horas después de la medianoche para procesarlos desde todas las regiones y completar todos los datos de autorización del día anterior. Las llamadas a la API de auditoría para una cuenta determinada y un día determinado se almacenan en caché en el lado de la API. Si ejecuta un informe antes de la medianoche sugerida + 6 horas, es posible que su informe sea incorrecto o esté incompleto.

Solicite un informe de uso diario

Parámetros

Campo	Tipo	Descripción
`accountID`	Cadena	Su ID de cuenta de Video Cloud
`date`	Cadena	Validaciones: Formato AAAA-MM-DD La fecha no puede ser hoy (hora UTC) La fecha no puede tener más de 30 días de antigüedad. Brightcove no retiene los informes de uso del servicio de autorización después de 30 días para cumplir con el RGPD

Solicitud

Método	PUBLICACIÓN
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{ID de la cuenta}/consulta/{fecha}
Encabezados	Autorización: Portador tu token de acceso
Encabezados	Tipo de contenido: application/json

Respuesta

Respuesta de muestra (200 OK):

{
	"executionID":  "abcdef-asfdag-dvsbcd"
}

Detalles:

Campo	Tipo	Descripción
`executionID`	Cadena	Un ID único asociado con un informe de uso para un determinado `accountID` y `date`. Esta identificación se pasa a los otros puntos finales a continuación.

Verifique el estado de su informe

Solicitud

Método	OBTENER
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{ID de la cuenta}/ejecución/{executionID}/estado
Encabezados	Autorización: Portador tu token de acceso
Encabezados	Tipo de contenido: application/json

Respuesta

Respuesta de muestra (200 OK):

{
	"status":  "completed"
}

Detalles:

Campo	Tipo	Descripción
`status`	Cadena	Valores: "completado", "procesando", "fallido"

Obtenga su informe

Solicitud

Método	OBTENER
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{ID de la cuenta}/ejecución/{executionID}/informe
Encabezados	Autorización: Portador tu token de acceso
Encabezados	Tipo de contenido: application/json

Respuesta

Respuesta de muestra (200 OK):

{
    "signedURL":  "https://signed-url",
    "expirationTime":  1569219842
}

Detalles:

Campo	Tipo	Descripción
`SignedURL`	Cadena	Los resultados se devuelven como una URL de S3 que puede descargar.
`expirationTime`	Marca de tiempo de la época	Las URL de S3 firmadas son válidas durante 15 minutos.

Limitaciones

Las siguientes limitaciones se aplican con la versión inicial de esta función:

Hay un límite de 100 fichas en la lista negra. Después de eso, se lanzará un error.