soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Área de práctica: CMS API

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

    Resumen

    Este inicio rápido lo ayudará a familiarizarse con las operaciones disponibles a través del CMS API. El CMS API habilita más de 30 diferentes operaciones, 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

    Como la mayoría de las API RESTful de Brightcove, el CMS API requiere OAuth tokens de 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 muestra de Brightcove Learning Services, por lo que no necesitará obtener credenciales aquí, pero debe comprender lo que está sucediendo. los CodePen envía la información de solicitud de API a un proxy similar a esta. El proxy accede a las credenciales del cliente desde una ubicación privada y las usa para generar un token de acceso temporal utilizando el OAuth API y luego realiza la solicitud de API y devuelve los datos de respuesta.

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

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

      También puede obtener credenciales usando el OAuth API, siguiendo las instrucciones en una de las guías enumeradas a continuación. Se puede usar lo siguiente con curl o Postman para obtener los permisos adecuados:

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

    CodePen

    Use el CodePen a continuación para probar varios CMS API solicitudes y ver cómo se ve la solicitud y los datos de respuesta.

    Código fuente

    Encuentre todo el código asociado con esta muestra en este Repositorio GitHub.

    Aplicación de ejemplo

    Vea la pluma CMS API Empieza por Brightcove Learning Services (@rcrooks1969) Sobre CodePen.

    Usando el CodePen

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

    • Alterne la visualización real de la aplicación haciendo clic en Resultado .
    • Haga clic en el HTML / CSS / JS botones para visualizar 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.
    • Encuentre todo el código asociado con esta muestra en este Repositorio GitHub.

    Código proxy

    Para crear su propia versión de la aplicación de muestra en esta página, debe crear y alojar su propio proxy. (Los proxies utilizados por Brightcove Learning Services solo aceptan solicitudes de dominios de Brightcove). Puede encontrar 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 Uso de las API REST.


    Página actualizada por última vez el 24 de agosto de 2020