soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema

Conceptos: Herramientas de prueba para API de Brightcove

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

Lista de herramientas

Las siguientes herramientas se discuten en esta guía:

Herramientas de prueba de API
Herramienta de prueba API
api-tester.sh Cualquier API que use Brightcove OAuth para autenticar solicitudes
probador en línea Cualquier API que use 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 de Windows
  • Una herramienta de prueba en línea que debería funcionar en cualquier navegador
  • Una guía para usar el popular Probador API REST de Postman

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 hacer llamadas a la API. El script api-tester usa cURL para hacer llamadas http. cURL está integrado en Mac MacOS y todos los sistemas Unix / Linux. Para obtener cURL en Windows, consulte Configurando cURL. Luego descarga el script api-tester.sh

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

Ejecutando el script de shell

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

	bash api-tester.sh

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

  • ID de cliente (ver el sección a continuación al obtener las credenciales del cliente)
  • Client Secret (ver el sección a continuación al obtener las credenciales del cliente)
  • La llamada completa a la API (ejemplo: https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • El verbo de solicitud - uno de los siguientes: OBTENER | POST | PATCH | PON | DELETE (GET es el valor predeterminado)
  • Datos de solicitud: utilizados para POST, PATCH y PUT; para solicitudes GET y DELETE, lo dejará en blanco y solo presione retorno

La herramienta de línea de comandos devolverá la misma respuesta que el herramienta en línea Sin embargo, también se hace eco de la respuesta completa, que le permite ver los encabezados y más información si la solicitud falla por algún motivo. También emite el JSON sin procesar para la respuesta, así como una versión bastante 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, te pide:

  • Una identificación de cliente
  • Un secreto de cliente
  • La URL de solicitud API completa
  • El tipo de solicitud
  • Los datos JSON que se enviarán, si los hay

Insomnio

ver el guía paso a paso para hacer solicitudes de API usando Insomnia.

Cartero

ver el guía paso a paso para hacer solicitudes de API usando Postman.

Obtener credenciales

Para utilizar las API de Brightcove, necesitará las credenciales de cliente adecuadas, que consisten en un client_id y client_secret. Consulte la Descripción general de OAuth para obtener una mejor comprensión del flujo de credenciales del cliente.

Conseguir un client_id y client_secret, deberás dirigirte a la interfaz de usuario de OAuth y registrar una aplicación:

También puede obtener sus credenciales a través de CURL o cartero, consulte:


Última actualización de la página el 16 mar 2020