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

    Área de Práctica: CMS API

    En este tema, aprenderá cómo comenzar con el CMS API observando algunos de los tipos de solicitud comunes y los datos que devuelven.

    Resumen

    Este inicio rápido le ayudará a familiarizarse con las operaciones disponibles a través de CMS API. El CMS API habilita más de 30 operaciones diferentes, por lo que este tutorial no cubre todas ellas, sino que le permite probar algunas de las más utilizadas para ver qué tipo de datos devuelven.

    Obtener credenciales

    Al igual que la mayoría de las API RESTful de Brightcove, el CMS API requiere tokens de OAuth acceso para autorizar solicitudes. Para obtener tokens de acceso, primero debe obtener credenciales de cliente con permisos para los tipos de operaciones que desea solicitar. Este inicio rápido realiza solicitudes de API en una cuenta de ejemplo de Brightcove Learning Services, por lo que no necesitará obtener credenciales aquí, pero debe comprender lo que está sucediendo. El CodePen envía la información de solicitud de API a un proxy similar a éste. El proxy accede a las credenciales de cliente desde una ubicación privada y las utiliza para generar un token de acceso temporal utilizando OAuth API y, a continuación, realiza la solicitud API y devuelve los datos de respuesta.

    Para probar solicitudes en su propia cuenta, obtenga sus credenciales de cliente y use una de nuestras herramientas de prueba de API.

    1. Para obtener sus credenciales, siga las instrucciones de Administrar credenciales de API. Esta es la forma recomendada de obtener las credenciales de cliente. En la mayoría de los casos, es probable que desee obtener todos los permisos:
      Permisos de OAuth
      Permisos de OAuth

      También puede obtener credenciales utilizando OAuth API, siguiendo las instrucciones de una de las guías que se enumeran a continuación. Lo siguiente se puede usar con curl o Postman para obtener los permisos adecuados:

      "operations": ["video-cloud/video/all"]

    CodePen

    Utilice el CodePen a continuación para probar varias CMS API solicitudes y ver cómo se ven la solicitud y los datos de respuesta.

    Código fuente

    Encuentra todo el código asociado a esta muestra en este repositorio de GitHub.

    Aplicación de muestra

    Consulte el Inicio rápido de la API de Pen CMS de Brightcove Learning Services (@rcrooks1969 ) en CodePen.

    Uso del CodePen

    Aquí hay algunos consejos para usar eficazmente el CodePen anterior:

    • Alterna la visualización real de la aplicación haciendo clic en el botón Resultado.
    • Haga clic en los botones HTML/CSS/JS para mostrar UNO de los tipos de código.
    • Haga clic en Editar en CodePen en la esquina superior derecha para bifurcar este CodePen en su propia cuenta.
    • Encuentra todo el código asociado a esta muestra en este repositorio de GitHub.

    Código proxy

    Para crear su propia versión de la aplicación de ejemplo en esta página, debe crear y alojar su propio proxy. (Los servidores proxy utilizados por Brightcove Learning Services sólo aceptan solicitudes de dominios de Brightcove.) Un proxy de muestra, muy similar al que usamos, pero sin las comprobaciones que bloquean las solicitudes de dominios que no son de BrightCove, se puede encontrar en este repositorio de GitHub. También encontrará instrucciones básicas para usarlo allí, y una guía más elaborada para crear aplicaciones alrededor del proxy en Using the REST API.


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