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

    Conceptos: Herramientas de prueba para API de Brightcove

    En este tema, aprenderá acerca de las herramientas que proporciona Brightcove Learning Services para ayudarle a probar y aprender las API RESTful de Brightcove.

    Lista de herramientas

    En esta guía se analizan las siguientes herramientas:

    Herramientas de prueba de API
    Herramienta de prueba APIs
    api-tester.sh Cualquier API que utilice Brightcove OAuth para autenticar solicitudes
    probador en línea Cualquier API que utilice Brightcove OAuth para autenticar solicitudes
    Insomnio Cualquier API REST, independientemente del método de autenticación
    Cartero Cualquier API REST, independientemente del método de autenticación
    • Un script de shell que se puede ejecutar desde la línea de comandos si está trabajando en macOS u otro sistema UNIX o LINUX, o si tiene cURL instalado en un sistema Windows
    • Una herramienta de prueba en línea que debería funcionar en cualquier navegador
    • Una guía para usar el popular Postman REST API Tester

    El script de shell (cURL)

    La herramienta de línea de comandos es un script de shell llamado api-tester.sh para obtener tokens de acceso y realizar las llamadas a la API. El script api-tester utiliza cURL para realizar llamadas http. cURL está integrado en Mac MacOS y todos los sistemas Unix/Linux. Para obtener cURL en Windows, consulte Configuración de cURL. A continuación, descargue el script api-tester.sh

    Puede ver el código completo para el script de shell en Obtener tokens de acceso.

    Ejecutar el script de shell

    Después de descargar el script de shell, descomprimirlo donde desee y luego vaya a una línea de comandos en la misma carpeta. Para ejecutar el script, escriba:

    	bash api-tester.sh

    Cada vez que ejecute el script, le pedirá 5 variables:

    • Id. de cliente (consulte la sección a continuación sobre la obtención de credenciales de cliente)
    • Secreto del cliente (consulte la sección a continuación sobre la obtención de credenciales de cliente)
    • La llamada API completa (ejemplo: https://cms.api.brightcove.com/v1/accounts/12345678/videos
    • El verbo de solicitud - uno de los siguientes: GET | POST | PARCHE | PUT | ELIMINAR (GET es el valor predeterminado)
    • Datos de solicitud: se utiliza para POST, PATCH y PUT; para las solicitudes GET y DELETE, dejará este espacio en blanco y simplemente presione return

    La herramienta de línea de comandos devolverá la misma respuesta que la herramienta en línea ; sin embargo, también hace eco de la respuesta completa, lo que le permite ver los encabezados y más información si la solicitud falla por algún motivo. También hace eco al JSON crudo para la respuesta, así como una versión bonita impresa.

    La herramienta en línea

    La herramienta de prueba en línea se puede encontrar aquí. Al igual que la herramienta de línea de comandos, le pide:

    • Un ID de cliente
    • Un secreto de cliente
    • La URL de solicitud de API completa
    • El tipo de solicitud
    • Los datos JSON que se enviarán, si los hubiere

    Insomnio

    Consulte la guía paso a paso para realizar solicitudes de API usando Insomnia.

    Cartero

    Consulte la guía paso a paso para realizar solicitudes de API con Postman.

    Obtener credenciales

    Para utilizar las API de Brightcove necesitará las credenciales de cliente adecuadas, que constan de un client_id y client_secret. Consulte la descripción general de OAuth para comprender mejor el flujo de credenciales del cliente.

    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:


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