soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    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

    Tenga en cuenta que esta versión de la descripción general es para cuentas que están habilitadas para Entrega dinámica. Esas cuentas pueden o no estar habilitadas para la codificación consciente de contexto. Hay una descripción general independiente para los perfiles de ingesta heredados.

    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.

    Consulte también la 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 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": "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.", ...

    «multi-plataforma extended-estática» o «f1b16093e2dc4f81810f1488" 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

    Consulte Prácticas recomendadas de perfiles de ingesta.

    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 la Referencia de API para obtener detalles y cuerpos de solicitud de muestra, y Referencia de campos de perfil para los campos permitidos.

     

    Crear un perfil Live

    Para crear un perfil de ingesta personalizado para Live, basta con especificar las copias HLS con el live_stream valor establecido en 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 sólo debe utilizar la rendition configuración de ingesta heredada para los perfiles Live, no la dynamic_origin configuración de los perfiles de entrega dinámica.

    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, multiplataforma estandar-estandar-estática)
    • id generado (por ejemplo, f1b16093e2dc4f81810f1488)

    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.

    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, multiplataforma estandar-estandar-estática)
    • id generado (por ejemplo, f1b16093e2dc4f81810f1488)

    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}
    }

    Establecer el perfil de recorte social predeterminado

    Establecer el perfil de recorte social 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_social_clipping_profile_id": {default_social_clipping_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 desea añadir marcas de agua (o una imagen de logotipo) a sus vídeos, póngase en contacto con el servicio de asistencia de Brightcove.


    Última actualización de la página el 28-09-2020