Usar Insomnio para Solicitudes de API

Introducción

Algunos encuentran las declaraciones curl y la línea de comandos, utilizados para muchos de los ejemplos en la documentación de nuestra plataforma API, difíciles e intimidantes. Para ellos, existen numerosas herramientas para enviar solicitudes HTTP a servicios basados en REST, que incluyen la mayoría de las API de Brightcove. Este documento le mostrará cómo usar una herramienta popular, la Insomnia aplicación.

Instalar Insomnia

Obtener Insomnia de https://insomnia.rest . Insomnia se pueden instalar en sistemas Mac, Linux o Windows.

Insomnia se puede utilizar para realizar solicitudes a cualquiera de las API RESTful de Brightcove. La mayoría de las API utilizan OAuth2 para la autenticación, y eso es lo que demostraremos en este documento. Sin embargo, también puede usarlo para las API que no usan OAuth, simplemente estableciendo el encabezado apropiado.

Así es como se verá ese encabezado para las solicitudes con diferentes métodos de autenticación:

OAuth API( sólocrear solicitud de credenciales)

  Authorization: BC_TOKEN YOUR_BC_TOKEN

¿ Cómo obtener su BC_TOKEN.

Playback API

  BCOV-Policy: YOUR_POLICY_KEY

Live API

  X-API-KEY: YOUR_API_KEY

API de Zencoder

  Zencoder-Api-Key: YOUR_API_KEY

Obtener credenciales de cliente

Para trabajar con la mayoría de las API de Brightcove, necesitará credenciales de cliente para la cuenta y las API que desea utilizar. Obtenga sus credenciales de cliente en Studio siguiendo las instrucciones de Administrar credenciales de autenticación de API. En los pasos a continuación, realizaremos Player Management API solicitudes usando Insomnia , por lo que sus credenciales deben tener al menos los siguientes permisos:

• Jugadores: Lectura/Escritura

Puede agregar tantos permisos adicionales como desee para obtener credenciales que se puedan utilizar para una gama más amplia de solicitudes de API. También tenga en cuenta que puede obtener credenciales que funcionarán para varias cuentas si lo desea.

Uso de Insomnia

Una vez que tenga sus credenciales de cliente, estará listo para empezar a usar Insomnia. Los pasos a continuación le guian a través de la realización de algunas solicitudes de API de Player Management utilizando Insomnia.

Configuración de un Insomnia espacio de trabajo

En caso de que trabaje con otras API, puede que desee crear un espacio de trabajo solo para solicitudes de Brightcove.

1. Inicie la Insomnia aplicación.
2. Haga clic en el menú desplegable junto a Insomnia y seleccione Nuevo espacio de trabajo:

   

3. Introduzca el nombre Brightcove y haga clic en Crear:

   

4. Haga clic en el signo más y seleccione Nueva carpeta:

   

5. Dale a tu carpeta el nombre Player Management API

Enviar solicitudGET

Ahora estamos listos para hacer algunas solicitudes de API.

Hacer una solicitudGET

1. Haz clic en el icono del menú desplegable de tu nueva carpeta y selecciona Nueva solicitud:

   

2. Asigne a la solicitud el nombre Get All Players, deje el método HTTP como y GET haga clic en crear.
3. Reemplace la URL de solicitud genérica con:

     https://players.api.brightcove.com/v2/accounts/account_id/players

   Reemplace account_id con su propio ID de cuenta:

   

4. Expanda el menú desplegable Auth y seleccione OAuth 2.0:

   

5. Para el Tipo de concesión, seleccione Credenciales de cliente:

   

6. Introduzca valores para la URL del token de acceso, el ID del cliente y el secreto del cliente:

   Entradas de OAuth

   URL del token de acceso	https://oauth.brightcove.com/v4/access_token
   IDENTIFICADOR DE CLIENTE	su ID de cliente
   Secreto del cliente	secreto de su cliente

7. Haga clic en Obtener tokens para asegurarse de que esto funcione. Deberías ver una respuesta como esta:

   

8. Haga clic en Enviar:

   

9. La respuesta debería verse algo como esto:

   

Enviar solicitudPOST

Ahora, enviaremos una POST solicitud con algunos datos. En este caso, crearemos un nuevo objeto de vídeo utilizando la API de Player Management.

Para ello, duplicaremos la solicitud Obtener todos los jugadores y modificaremos según sea necesario. Otra buena característica de Insomnia es que cuando duplica una solicitud, toda la información de autenticación se duplica junto con ella, por lo que no tendrá que configurar la obtención de tokens de acceso nuevamente.

Hacer una solicitudPOST

1. Haga clic en la carpeta Player Management API para mostrar la solicitud Obtener todos los jugadores dentro de ella.
2. Expanda el menú desplegable de la solicitud Obtener todos los jugadores y seleccione Duplicar:

   

3. Haga doble clic en el nombre Get All Players (Copiar) y cámbielo a Crear jugador
4. Utilice la misma URL que para los pasos de solicitud GET anteriores, pero ahora elija POST ser el método HTTP seleccionado.

   

5. Haga clic en el Cuerpo para expandir el menú desplegable y seleccione JSON:

   

6. Para los datos del cuerpo , introduzca el siguiente código JSON para el cuerpo (la captura de pantalla que sigue al JSON muestra cómo debería aparecer la solicitud):

     {
     "name": "MySamplePlayer",
         "configuration": {
             "media": {
             "sources": [{
                 "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                 "type":"video/mp4"
                 }]
             }
         }
     }
     
     

     {
         "name": "MySamplePlayer",
         "configuration": {}
     }
     
     

   

   

7. Haga clic en Enviar.

8. Su respuesta se verá similar a la siguiente (Puede hacer clic en el botón Pretty para JSON con un formato más agradable):

   

9. Puede comprobar que el reproductor se creó marcando el módulo Players en Studio.

Variables de entorno

Puede resultarle útil utilizar Insomniaes Ambientes para guardar las credenciales de OAuth para diferentes API, o para guardar otra información como la identificación de su cuenta y los identificadores de video o reproductor.

A continuación se muestran los pasos para crear y utilizar variables de entorno para el client_id , client_secret y account_id.

1. Haga clic en Sin entornos en la parte superior izquierda de Insomnia para expandir el menú desplegable y seleccione Administrar entornos.

   

2. En el cuadro de diálogo Administrar entornos , haga clic en el signo + junto a Sub Entornos para expandir el menú desplegable y seleccione Entorno para crear un nuevo entorno:

   

3. Haga doble clic en el nombre del nuevo entorno para cambiarlo a Player Management API (o lo que desee).
4. Dentro de las llaves para el entorno JSON, agregue estos pares clave-valor:
   • "account_id": "su ID de cuenta»
   • "client_id": "su ID de cliente»
   • "client_secret": "secreto de su cliente»

   Cuando haya terminado, el JSON debería verse así:

   

   (El secreto del cliente aquí se borra por razones de seguridad).

5. Haga clic en Listo para agregar el entorno
6. Haga clic de nuevo en Sin entorno para expandir el menú desplegable y seleccione Usar entorno de administración del reproductor (o el nombre que haya dado al nuevo entorno):

   

7. Ahora selecciona la solicitud Obtener todos los jugadores de nuevo para volver a abrirla.
8. Haga clic en OAuth 2 para volver a abrir la sección de autenticación.
9. Elimine el valor de id del cliente y comience a escribir client_id - verá un menú desplegable que muestra las variables de entorno relevantes, donde debe seleccionar client_id:

   

10. Ahora seleccione el ID de cuenta en la URL de solicitud y reemplácelo por la variable account_id .
11. Haga lo mismo para reemplazar el valor Client Secret con la variable client_secret .
12. Ahora haga clic en Enviar de nuevo para asegurarse de que la solicitud sigue funcionando.

Conclusión

Ahora conoce los conceptos básicos de utilizar Insomnia para realizar solicitudes a las API de Brightcove. Tenga en cuenta que si decide actualizar su Insomnia cuenta gratuita a una cuenta de equipo, también puede sincronizar todas sus solicitudes y entornos y compartirlos con otros miembros del equipo.