Resumen: Ingest Profiles API

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

Administración de perfiles de ingestión

Los perfiles de ingesta se utilizan como especificación para la transcodificación al cargar o volver a transcodificar vídeos. Puede administrar estos perfiles mediante la API de perfiles de ingesta.

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 copia como una lista. Consulte Perfiles estándar para ver el JSON para ver los perfiles estándar incluidos en cada cuenta y Seguridad de contenido (DRM y HLSE) para ver perfiles de muestra que incluyen empaquetado de DRM.

ID de perfil

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

    {
        "id": "5591b5ede4b0f7138939ad8c",
        "version": 4,
        "name": "screencast-1280",
        "description": "A high resolution profile optimized for screencasts with 1280 x 720 resolution.", ...

«screencast-1280" o «5591b5ede4b0f7138939ad8c» son ambos identificadores de perfil válidos. Cuando cree un perfil por primera vez, proporcionará un perfil con un nombre pero sin identificador, y la respuesta contendrá el perfil creado incluyendo su id. A continuación, puede usar cualquiera de las dos en cualquier llamada a la API posterior.

Id. de referencia

A reference_id identifica de forma única una copia dentro de un perfil. Los identificadores de referencia se utilizan para embalajes DRM y pueden utilizarse para otros fines en el futuro. Aparte de ser únicos dentro del perfil, los identificadores de referencia pueden ser cualquier cadena; no debe incluir espacios. Recomendamos utilizar algún esquema que facilitará la identificación del formato de la copia, por ejemplo:,,,, etc.mp4_1mp4_2hls1hls2

Versión del perfil

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

Perfil activo

Un perfil es active si se puede utilizar para subidas. Por ejemplo, si actualiza un perfil, obtendrá 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 de una sola cuenta).

Perfil predeterminado

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

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 (un ID de cliente y un secreto de cliente) que tengan permisos para las siguientes operaciones en sus cuentas:

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

Para obtener un y, deberá ir a la interfaz de usuario de OAuth y registrar una aplicación:client_idclient_secret

Administración de credenciales de autenticación de API

También puede obtener sus credenciales a través de CURL o Postman - consulte:

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}

Consulte la sección Oauth para obtener más información.

Máximo de copias

El número máximo de copias que puede definir en un perfil de ingesta es 25. Si define más de ese número, la solicitud devolverá una respuesta de error 409: el recuento de copias del perfil supera el límite de copia configurado.

Salidas condicionales

Si los vídeos que ingeres varían mucho en calidad (por ejemplo, los vídeos podrían incluir contenido generado por el usuario creado en teléfonos con cámaras de baja calidad), puede que desee condicionar la generación de algunas representaciones a la velocidad de bits u otra propiedad del vídeo de origen. Esto evitará la creación y el almacenamiento de copias redundantes. Consulte Salidas condicionales para obtener más información sobre cómo hacerlo.

Operaciones de cuenta

En el nivel de cuenta, puede obtener todos los perfiles para la cuenta y crear otros nuevos.

Endpoint

    /accounts/{account_id}/profiles

Obtener todos los perfiles

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

Crear un perfil

Para crear un nuevo perfil, debe enviar una solicitud POST al extremo mostrado anteriormente, incluidos los datos JSON para el perfil como el cuerpo de la solicitud. Consulte el perfil de ejemplo a continuación para obtener un ejemplo de los datos JSON y la Referencia de campos de perfil para los campos permitidos.

Operaciones de perfil único

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

Endpoint

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

Para el profile_id, puede usar cualquiera de las opciones:

nombre (por ejemplo, equilibrado-alta definición)
id generado (por ejemplo, 54de14cce4b0a6d2bf9cb08a)

Obtener un perfil por id

Para recuperar un único perfil, realice una solicitud GET al extremo que se muestra arriba.

Actualizar un perfil

Para actualizar un perfil, realice una solicitud PUT en el extremo anterior, incluyendo los datos JSON completos para el perfil en el cuerpo de la solicitud.

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

Eliminar un perfil

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

Esta acción es irreversible

Operaciones de perfil predeterminadas

Puede obtener, establecer o actualizar los perfiles predeterminados de vídeo a petición y vídeo en directo de su cuenta mediante el endpoint:

    /accounts/{account_id}/configuration

Obtener el perfil predeterminado

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

Si no se ha establecido ningún perfil predeterminado, se devolverá el perfil predeterminado del sistema.

Establecer el perfil predeterminado

Para establecer el perfil predeterminado, realice una solicitud POST al extremo mostrado anteriormente, incluyendo 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, equilibrado-alta definición)
id generado (por ejemplo, 54de14cce4b0a6d2bf9cb08a)

Actualizar el perfil predeterminado

Para actualizar el perfil predeterminado, realice una solicitud PUT al extremo mostrado anteriormente, incluyendo este JSON en el cuerpo de la solicitud:

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

Obtener el configuration_id de la respuesta a una solicitud GET o POST.

Configuración del perfil activo predeterminado

Establecer el perfil activo predeterminado es exactamente lo mismo que establecer el perfil predeterminado de vídeo bajo demanda, 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}
    }

Notas:

Si especifica un perfil inexistente, la solicitud fallará

Perfil de muestra

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

Marcas de agua

Si quieres añadir marcas de agua (o una imagen de logotipo) a tus vídeos, puedes usar los campos de marca de agua en tu perfil de ingesta.

A continuación se muestra un ejemplo de un perfil de copia con marcas de agua:

    ...
    "renditions": [
        {
          "media_type": "video",
          "id": "559697ece4b072e9641b8404",
          "reference_id": "mp0",
          "format": "mp4",
          "audio_codec": "aac",
          "audio_bitrate": 64,
          "video_codec": "h264",
          "speed": 3,
          "video_bitrate": 450,
          "decoder_bitrate_cap": 771,
          "decoder_buffer_size": 1028,
          "keyframe_rate": 0.5,
          "max_frame_rate": 30,
          "width": 480,
          "height": 270,
          "h264_profile": "baseline",
          "watermarks": [
            {
              "y": "70%",
              "width": "20%",
              "url": "http://learning-services-media.brightcove.com/images/bc_logo.png"
            }
          ]
      }, ...

Consulte < a href=» https://zencoder.support.brightcove.com/encoding-settings/assets/encoding-settings-watermarks.html Referencia de campos de > marca de agua < /a > para obtener una explicación completa de los campos.</p > < > < /sección/artículo > <!— diseño completo de arranque — > < /div > < div class="col-sm-2 barra derecha» >

Contenido de la página

Resumen: Ingest Profiles API

Administración de perfiles de ingestión

Glosario de términos

URL base

Autorización

Máximo de copias

Salidas condicionales

Operaciones de cuenta

Endpoint

Obtener todos los perfiles

Crear un perfil

Operaciones de perfil único

Endpoint

Obtener un perfil por id

Actualizar un perfil

Eliminar un perfil

Operaciones de perfil predeterminadas

Obtener el perfil predeterminado

Establecer el perfil predeterminado

Actualizar el perfil predeterminado

Configuración del perfil activo predeterminado

Notas:

Perfil de muestra

Marcas de agua