Conceptos: Herramientas de prueba para las API de Brightcove
Lista de herramientas
Las siguientes herramientas se tratan en esta guía:
| Herramienta de prueba | API |
|---|---|
| api-tester.sh que es | 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 o algún 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 probador de 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 realizar llamadas a la API. El script api-tester usa cURL para realizar llamadas http. cURL está integrado en Mac MacOS y todos los sistemas Unix / Linux. Para obtener cURL en Windows, consulte Configurar cURL. Luego descarga el secuencia de comandos api-tester.sh
Puede ver el código completo del script de shell en Obtener tokens de acceso.
Ejecutando el script de shell
Después de descargar el script de shell, descomprímalo donde quiera 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 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 el sección a continuación sobre la obtención de credenciales de cliente)
- La llamada a la API completa (ejemplo:
https://cms.api.brightcove.com/v1/accounts/12345678/videos - El verbo de solicitud: uno de los siguientes: OBTENER | POST | PARCHE | PUT | BORRAR (OBTENER es el valor predeterminado)
- Solicitar datos: se utilizan para POST, PATCH y PUT; para las solicitudes GET y DELETE, dejará este espacio en blanco y simplemente presione regreso
La herramienta de línea de comandos devolverá la misma respuesta que la herramienta en línea - sin embargo, también se hace eco de la respuesta completa, lo que le permite ver los encabezados y más información si la solicitud falla por alguna razón. También se hace eco del JSON sin procesar para la respuesta, así como una versión bastante impresa.
La herramienta online
La herramienta de prueba en línea se puede encontrar aquí. Al igual que la herramienta de línea de comandos, le solicita:
- Una identificación 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 hubiera
Insomnio
Ver el guía paso a paso para realizar solicitudes de API usando Insomnia.
Cartero
Ver el 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 consisten en un client_id y client_secret. Ver el Descripción general de OAuth para comprender mejor el flujo de credenciales del cliente.
Conseguir un client_id y client_secret , deberá ir a la interfaz de usuario de OAuth y registrar una aplicación:
También puedes obtener tus credenciales a través de CURL o Postman. Consulta: