Descripción general: API de perfiles de ingesta

En este tema, obtendrá una descripción general de la API Ingest Profiles. La API de Ingest Profiles le permite crear, recuperar, actualizar y eliminar perfiles de reproducción para su cuenta de Video Cloud.

Gestión de perfiles de ingesta

Tenga en cuenta que las cuentas de Brightcove pueden o no estar habilitadas para Codificación sensible al contexto.

Los perfiles de ingesta se utilizan como una especificación para la transcodificación cuando carga o vuelve a transcodificar videos. Puede administrar estos perfiles utilizando la API de Ingest Profiles.

También vea el Referencia de API.

Glosario de términos

Perfil JSON

El término "perfil JSON" a continuación significa la representación JSON de un objeto de perfil. Contienen campos de perfil de nivel superior y una colección de objetos de reproducción como una lista.

Perfil Id

A profile id puede ser el id o name campo de nivel superior en un perfil. En este ejemplo (un fragmento de un perfil):

{
		"id": "f1b16093e2dc4f81810f1488",
		"version": 1,
		"name": "multi-platform-extended-static",
		"description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.", ...

"multiplataforma-extendida-estática" o "f1b16093e2dc4f81810f1488" son ID de perfil válidos. Cuando cree un perfil por primera vez, proporcionará un perfil con un nombre pero sin una identificación, y la respuesta contendrá el perfil creado, incluida su identificación. A continuación, puede utilizar cualquiera de los dos en cualquier llamada API posterior.

Identificación de referencia

A reference_id identifica de forma única una interpretación dentro de un perfil. Los identificadores de referencia se utilizan para el empaquetado de DRM y pueden utilizarse para otros fines en el futuro. Además de ser únicos dentro del perfil, los identificadores de referencia pueden ser cualquier cadena, no deben incluir espacios. Recomendamos utilizar algún esquema que facilite la identificación del formato de la interpretación, por ejemplo: mp4_1 , mp4_2 , hls1 , hls2 , etc.

Versión de perfil

A version es el número de revisión de un perfil para una cuenta. Está representado por un valor entero largo. Nota: no se cita en la representación JSON.

Perfil activo

Un perfil es active si se puede utilizar para cargas. Por ejemplo, si actualiza un perfil, obtiene un nuevo perfil con un número de versión incrementado que está activo y la versión anterior se vuelve inactiva.

Perfil estándar

Un perfil es standard si se proporciona para su uso por Brightcove (es decir, no es un perfil personalizado específico para una sola cuenta).

Perfil por defecto

Un perfil es default si se usa cuando no se elige explícitamente ningún perfil. Si no tiene una configuración de cuenta, o no establece un perfil predeterminado en su configuración, uno de los Brightcove standard Los perfiles se utilizarán de acuerdo con su tipo de cuenta.

URL base

La URL del servicio es:

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

Autorización

La autorización para la API se realiza a través de la implementación OAuth2 de Brightcove. Necesitará credenciales de cliente (una identificación de cliente y un secreto de cliente) que tenga permisos para las siguientes operaciones en su (s) cuenta (s):

video-cloud/ingest-profiles/profile/read
video-cloud/ingest-profiles/profile/write
video-cloud/ingest-profiles/account/read
video-cloud/ingest-profiles/account/write

Conseguir un client_id y client_secret , deberá ir a la interfaz de usuario de OAuth y registrar una aplicación:

Administración de credenciales de autenticación de API

También puedes obtener tus credenciales a través de CURL o Postman. Consulta:

Utilizará sus credenciales de cliente para obtener tokens de acceso que le permitirán realizar llamadas a la API. Los tokens de acceso se pasan en un encabezado de autorización:

Authorization: Bearer {your_access_token}

Ver el Sección Oauth para más información.

Representaciones máximas

Ver Mejores prácticas de perfiles de ingesta.

Operaciones de cuenta

A nivel de cuenta, puede obtener todos los perfiles de la cuenta y crear otros nuevos.

Punto final

/accounts/{account_id}/profiles

Obtener todos los perfiles

Para obtener todos los perfiles de la cuenta (incluidos perfiles estándar), envía una solicitud GET al punto final que se muestra arriba.

Crear un perfil

Para crear un perfil nuevo, envíe una solicitud POST al punto final que se muestra arriba, incluidos los datos JSON del perfil como cuerpo de la solicitud. Ver el Referencia de API para obtener detalles y cuerpos de solicitud de muestra, y Referencia de campos de perfil para los campos permitidos.

Crea un perfil en vivo

Para crear un perfil de ingesta personalizado para Live, simplemente necesita especificar las representaciones HLS con live_stream ajustado a true:

{
  "media_type": "video",
  "format": "ts",
  "segment_seconds": 6,
  "label": "hls1080p",
  "live_stream": true,
  "video_codec": "h264",
  "video_bitrate": 4000,
  "keyframe_interval": 60,
  "width": 1920,
  "height": 1080,
  "h264_profile": "high"
}

Tenga en cuenta que debe usar solo la ingesta heredada rendition configuraciones para perfiles en vivo, no la dynamic_origin configuración de los perfiles de Dynamic Delivery.

Operaciones de perfil único

Para perfiles individuales, puede obtener el perfil por nombre o identificación, reemplazar un perfil y eliminar un perfil.

Punto final

/accounts/{account_id}/profiles/{profile_id}

Para el profile_id , puedes usar cualquiera el:

nombre (por ejemplo, multiplataforma-estándar-estático)
ID generado (por ejemplo, f1b16093e2dc4f81810f1488)

Obtener un perfil por id

Para recuperar un solo perfil, realice una solicitud GET al punto final que se muestra arriba.

Actualizar un perfil

Para actualizar un perfil, realice una solicitud PUT al punto final anterior, incluido el completo Datos JSON para el perfil en el cuerpo de la solicitud.

Nota: el JSON para el perfil actualizado debe incluir la id propiedad.

Eliminar un perfil

Para eliminar un perfil, realice una solicitud DELETE al punto final anterior.

Esta acción es irreversible

Operaciones de perfil predeterminadas

Puede obtener, configurar o actualizar los perfiles de video a pedido y de video en vivo predeterminados para su cuenta usando el punto final:

/accounts/{account_id}/configuration

Obtener el perfil predeterminado

Recupere el perfil predeterminado de su cuenta realizando una solicitud GET al punto final anterior.

Si no se ha establecido un perfil predeterminado, se devolverá el perfil predeterminado del sistema.

Establecer el perfil predeterminado

Para establecer el perfil predeterminado, realice una solicitud POST al punto final que se muestra arriba, incluido el JSON en el cuerpo de la solicitud:

{
  "account_id": {account_id},
  "default_profile_id": {default_profile_id}
}

Para el default_profile_id , puede usar cualquiera de los siguientes:

nombre (por ejemplo, multiplataforma-estándar-estático)
ID generado (por ejemplo, f1b16093e2dc4f81810f1488)

Actualizar el perfil predeterminado

Para actualizar el perfil predeterminado, realice una solicitud PUT al punto final que se muestra arriba, incluido este JSON en el cuerpo de la solicitud:

{
  "id": {configuration_id},
  "account_id": {account_id},
  "default_profile_id": {default_profile_id}
}

Consigue el configuration_id desde la respuesta a una solicitud GET o POST.

Configuración del perfil en vivo predeterminado

Configurar el perfil en vivo predeterminado es exactamente lo mismo que configurar el perfil de video a pedido predeterminado, excepto por este cambio en el cuerpo de la solicitud:

{
  "id": {configuration_id},
  "account_id": {account_id},
  "default_live_profile_id": {default_live_profile_id}
}

Configuración del perfil de recorte social predeterminado

Configurar el perfil de recorte social predeterminado es exactamente lo mismo que configurar el perfil de video a pedido predeterminado, excepto por este cambio en el cuerpo de la solicitud:

{
  "id": {configuration_id},
  "account_id": {account_id},
  "default_social_clipping_profile_id": {default_social_clipping_profile_id}
}

Notas:

Si especifica un perfil inexistente, la solicitud fallará

Perfil de muestra

La Perfiles estándar El documento le mostrará todos los perfiles predeterminados que existen actualmente para todas las cuentas de Video Cloud.

Marcas de agua

Si desea agregar marcas de agua (o una imagen de logotipo) a sus videos, Póngase en contacto con el soporte de Brightcove.