Use insomnio para solicitudes de API

Introducción

Algunos consideran que las declaraciones curl y la línea de comandos, utilizadas para muchos de los ejemplos en la documentación de las API de nuestra plataforma, son 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 applicación.

Instalar Insomnia

Recibe Insomnia de https://insomnia.rest. Insomnia puede instalarse 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 usan 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 configurando el encabezado apropiado.

Aquí se muestra cómo se verá ese encabezado para las solicitudes con diferentes métodos de autenticación:

OAuth API (crear solicitud de credenciales -unicamente-)

  Authorization: BC_TOKEN YOUR_BC_TOKEN

Cómo llegar a su BC_TOKEN.

Playback API

  BCOV-Policy: YOUR_POLICY_KEY

Live API

  X-API-KEY: YOUR_API_KEY

Zencoder API

  Zencoder-Api-Key: YOUR_API_KEY

Obtenga las credenciales del 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 en Administrar Credenciales de Autenticación API. En los pasos a continuación, haremos Player Management API solicitudes de uso Insomnia, por lo que sus credenciales deben tener al menos los siguientes permisos:

• Players: Leer escribir

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

Usar Insomnia

Una vez que tenga sus credenciales de cliente, estará listo para comenzar a usar Insomnia. Los pasos a continuación lo guiarán para hacer algunos Player Management API solicitudes de uso Insomnia.

Configurando una Insomnia espacio de trabajo

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

1. Inicie el Insomnia aplicación.
2. Haga clic en el menú desplegable al lado Insomnia y seleccionar Nuevo espacio de trabajo:

   

3. Ingrese el nombre Brightcove y haga clic Crea:

   

4. Haga clic en el círculo azul con el signo de más (+) y seleccionar nueva carpeta:

   

5. Dale a tu carpeta el nombre Player Management API

Enviar GET solicitar

Ahora estamos listos para hacer algunas solicitudes de API.

Haz una GET solicitar

1. Haga clic en el ícono del menú desplegable en su nueva carpeta y seleccione Nueva solicitud:

   

2. Dale a la solicitud el nombre Obtener toda Players, deja el método HTTP como GETy haz clic en crear.
3. Reemplace la URL de solicitud genérica con:

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

   reemplazar ID de la cuenta con su propia identificación de cuenta:

   

4. Ampliar la Auth menú desplegable y seleccione OAuth 2.0:

   

5. Para la Tipo de beca, Seleccione Credenciales del cliente:

   

6. Ingrese valores para la URL del token de acceso, la identificación del cliente y el secreto del cliente:

   Entradas de OAuth

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

7. Haga clic en Fetch 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 más o menos así:

   

Enviar POST solicitar

Ahora, enviaremos un POST Solicitar con algunos datos. En este caso, crearemos un nuevo objeto de video usando el Player Management API.

Para hacer esto, duplicaremos el Obtener toda Players solicite y modifique 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 volver a configurar tokens de acceso.

Haz una POST solicitar

1. Clickea en el Player Management API carpeta para mostrar el Obtener toda Players solicitar dentro de ella.
2. Expande el menú desplegable para Obtener toda Players solicitar y seleccionar Duplicar:

   

3. Haga doble clic en el nombre Obtener toda Players (copia) y cambiarlo a Crea Player
4. Use la misma URL que utilizó para los pasos de solicitud GET arriba, pero ahora elija POST ser el método HTTP seleccionado.

   

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

   

6. Para la Cuerpo datos, ingrese el siguiente código JSON para el cuerpo (la captura de pantalla que sigue al JSON muestra cómo debe 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 será similar a la siguiente (Puede hacer clic en Bonita botón para JSON con el mejor formato):

   

9. Puedes verificar que tu player fue creado al registrar el Players módulo en estudio.

Variables de entorno

Puede ser útil usarlo Insomnia's Entornos para guardar las credenciales de OAuth para diferentes API, o para guardar otra información como la identificación de su cuenta y el video o player IDs.

A continuación se detallan los pasos para crear y usar variables de entorno para client_id , client_secret y account_id.

1. Haga clic en Sin ambientes en el área superior izquierda de Insomnia para expandir el menú desplegable y seleccionar Administrar entornos.

   

2. En la sección que pone Administrar entornos diálogo, haga clic en + firmar al lado Subentornos para expandir el menú desplegable y seleccionar Medio Ambiente para crear un nuevo ambiente:

   

3. Haga doble clic en el Nuevo ambiente nombre para cambiarlo a Player Management API (o lo que quieras).
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""su secreto de cliente"

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

   

   (El secreto del cliente aquí está borroso por razones de seguridad).

5. Haga clic en Terminado para agregar el ambiente
6. Haga clic en Sin ambiente de nuevo para expandir el menú desplegable y seleccionar Usando el Player Entorno de gestión (o el nombre que le dio al nuevo entorno):

   

7. Ahora seleccione el Obtener toda Players solicitar nuevamente para reabrirlo.
8. Haga clic en OAuth 2 para volver a abrir la sección de autenticación.
9. Elimine el valor de identificación del cliente y comience a escribir client_id - verá aparecer un menú desplegable que muestra variables de entorno relevantes, donde debe seleccionar client_id:

   

10. Ahora seleccione el ID de la cuenta en la URL de solicitud, y reemplazarlo por ID de la cuenta variable.
11. Haz lo mismo para reemplazar el Secreto del cliente valor con el client_secret variable.
12. Ahora haga clic en Enviar nuevamente para asegurar que la solicitud aún funcione.

Conclusiones

Ahora sabes los conceptos básicos del uso Insomnia hacer solicitudes a las API de Brightcove. Tenga en cuenta que si elige actualizar su versión gratuita Insomnia cuenta en una cuenta de equipo, también puede sincronizar todas sus solicitudes y entornos y compartirlos con otros miembros del equipo.