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

    Inicio rápido: Ingest Profiles API

    En este tema, aprenderá cómo utilizar la API de perfiles de ingesta para administrar perfiles de ingesta y transcodificar para su cuenta. Este tutorial le guiará a través de estas operaciones.

    Introducción

    La API de perfiles de ingest le permite:

    • Obtener los perfiles de su cuenta

    • Crear nuevos perfiles

    • Actualizar perfiles

    • Eliminar perfiles

    • Establecer o actualizar el perfil predeterminado de su cuenta

    Una API restful

    La API de perfiles de ingesta es una API RESTful. Acepta solicitudes HTTPS y devuelve una respuesta JSON.

    Esto significa que puede usar la API con cualquier idioma que elija - Ruby, Java, PHP, Python, JavaScript (a través de AJAX o nodejs), etc. Todo lo que tiene que hacer es hacer solicitudes HTTPS y manejar una respuesta JSON.

    La URL base

    La URL base para la API de perfiles de ingesta es:

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

    Autorización

    Las llamadas API se autorizan mediante tokens de acceso OAuth2. El token se pasa con solicitudes en un encabezado de autorización:

        Authorization: Bearer {access_token}

    Los tokens de acceso son de corta duración (5 min), por lo que debe obtener uno cada vez que realice una solicitud

    En estos ejercicios, realizaremos solicitudes a través de un proxy que obtendrá un token de acceso y luego realizaremos la solicitud.

    Configuración de los ejercicios

    Configuración

    Tiene dos opciones:

    • Realizar los ejercicios en una cuenta de muestra (recomendado)
    • Usa tu propia cuenta

    Obtener todos los perfiles

    Obtención de los perfiles de cuenta

    Para obtener todos los perfiles de una cuenta, haga una solicitud GET al endpoint:

        /accounts/{account_id}/profiles

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles

    Ejercicio 1: Obtener todos los perfiles

    Realice la siguiente solicitud GET:

    Creación de un perfil

    Creación de perfiles

    Para crear un perfil, realice una solicitud POST al extremo:

        /accounts/{account_id}/profiles

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles

    El JSON para el perfil se incluye como el cuerpo de la solicitud. Consulte la Referencia de campo de perfil para los campos de perfil, copia y paquete DRM

    Ejercicio 2: Crear un perfil

    Realice la siguiente solicitud POST:

    (La respuesta aparecerá en la siguiente diapositiva)

    Respuesta del ejercicio 2

    Obtención de un único perfil

    Obtención de un perfil por id

    Para recuperar un perfil por id, realice una solicitud GET al punto final:

        /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)

    Ejemplos:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/screencast
        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/54de14cce4b0a6d2bf9cb08a

    Ejercicio 3: Obtener un perfil

    Realice la siguiente solicitud GET para recuperar el perfil que creó:

    Actualización de un perfil

    Actualizar un perfil por id

    Para actualizar un perfil por id, realice una solicitud PUT al 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)

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile

    Incluya los datos del perfil en el cuerpo de la solicitud como lo hizo cuando creó el perfil. Los datos del perfil deben incluir el id para el perfil!

    Ejercicio 4: Actualizar perfil

    Realice la siguiente solicitud PUT para actualizar el perfil que ha creado (se actualizará la descripción):

    (La respuesta aparecerá en la siguiente diapositiva)

    Ejercicio 4 Respuesta

    Supresión de un perfil

    Eliminar un perfil por id

    Para eliminar un perfil por id, realice una solicitud DELETE al extremo:

        /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)

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile

    Ejercicio 5: Eliminar perfil

    Realice la siguiente solicitud DELETE para actualizar el perfil que ha creado (¡no se puede deshacer!):

    Obtención del perfil predeterminado

    Obtener el perfil predeterminado

    Para obtener el perfil predeterminado de la cuenta, realice una solicitud GET al punto final:

        /accounts/account_id/configuration

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                            

    Ejercicio 6: Obtener perfil predeterminado

    Realice la siguiente solicitud GET para obtener el perfil predeterminado de la cuenta:

    Configuración del perfil predeterminado

    Establecer el perfil predeterminado

    Para establecer el perfil predeterminado de la cuenta, realice una solicitud POST al extremo:

        /accounts/account_id/configuration

    Incluya este JSON como el cuerpo de la solicitud

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

    Al igual que con otras operaciones, puede usar el nombre o id para el profile_id.

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

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                            

    Ejercicio 7: Establecer perfil predeterminado

    Realice la siguiente solicitud POST para establecer el perfil predeterminado (tenga en cuenta que esto fallará si la cuenta ya tiene un perfil predeterminado; actualizaremos el valor predeterminado en el siguiente ejercicio):

    (La respuesta aparecerá en la siguiente diapositiva)

    Ejercicio 7 Respuesta

    Actualización del perfil predeterminado

    Actualizar el perfil predeterminado

    Para actualizar el perfil predeterminado de la cuenta, realice una solicitud PUT al punto final:

        /accounts/account_id/configuration

    Incluya este JSON como el cuerpo de la solicitud

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

    El ID de configuración se devuelve cuando se obtiene el perfil predeterminado. Si no hay ningún perfil predeterminado, consulte Configuración del perfil predeterminado. Al igual que con otras operaciones, puede usar el nombre o id para el profile_id.

    • nombre (por ejemplo, alta resolución)
    • id generado (por ejemplo, 54de14cce4b0a6d2bf9cb08a)

    Ejemplo:

        https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
                            

    Ejercicio 8: Actualizar perfil predeterminado

    Realice la siguiente solicitud PUT para actualizar el perfil predeterminado de la cuenta:

    (La respuesta aparecerá en la siguiente diapositiva)

    Ejercicio 8 Respuesta


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