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

    Usar Postman para solicitudes de API

    En este tema, aprenderá cómo configurar el popular cliente HTTP de Postman para realizar solicitudes a las API RESTful de Brightcove. Algunos encuentran las declaraciones curl y la línea de comando, utilizada para la mayoría de los ejemplos en esta sección de la documentación, 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 utilizar una de esas herramientas, la aplicación Postman.

    Instalar Postman

    Obtener Postman de www.getpostman.com . Postman se puede instalar como una aplicación de Chrome o Mac. Recomendamos obtener el cliente de escritorio, pero la versión de Chrome se ejecutará en cualquier plataforma y es idéntica en funcionalidad y apariencia.

    Obtener credenciales de cliente

    Para trabajar con las API de Brightcove, necesitará credenciales de cliente para la cuenta y las API que desea utilizar. Obtenga las credenciales de cliente en Studio siguiendo las instrucciones de Administrar credenciales de autenticación de API. En los pasos a continuación, realizaremos solicitudes de Player Management API usando Postman, 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 obtendrá credenciales que funcionarán para varias cuentas si lo desea.

    Puede utilizar esta aplicación en línea si lo prefiere. Si lo hace, debe especificar al menos video-cloud/player/all permisos.

    Uso de Postman

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

    Configuración Postman para obtener tokens de acceso

    1. Inicie la Postman aplicación.
    2. Crear una nueva solicitud:
      Crear nueva solicitud
      Crear nueva solicitud
    3. En el cuadro de diálogo de solicitud nueva, ingrese «Obtener jugadores» para el Nombre de la Solicitud:
      Nombre de la solicitud
      Nombre de la solicitud
    4. Haga clic en Crear colección y, a continuación, escriba «Player Management API» para el nombre de la colección:
      Crear colección de solicitudes
      Crear colección de solicitudes
    5. Guarde la colección.
    6. Busque la colección Player Management API en la lista de la izquierda y haga clic en ella para abrir su nueva solicitud:
      Colección de API de administración de jugadores
      Colección de API de administración de jugadores
    7. Vaya a la pestaña Autorización , elija OAuth 2.0 como tipo y asegúrese de que está seleccionado Agregar datos de autorización a encabezados de solicitud:
      Sección de Autorización
      Sección de Autorización
    8. Haga clic en Obtener nuevo token de acceso:
      Obtener un nuevo token de acceso
      Obtener un nuevo token de acceso
    9. En el cuadro de diálogo, introduzca la siguiente información:
      • Nombre del token: Player Management API
      • Tipo de concesión: Credenciales de cliente
      • URL del token de acceso: https://oauth.brightcove.com/v4/access_token
      • ID de cliente: (introduzca su ID de cliente)
      • Secreto del cliente: (ingrese el secreto de su cliente)
      • Alcance: (dejar en blanco).
      • Autenticación cliente: Enviar credenciales de cliente en el cuerpo
      Cuadro de diálogo Obtener token de acceso
      Cuadro de diálogo Obtener token de acceso
    10. Haga clic en Solicitar token
    11. Debería ver que aparece un nuevo token de acceso:
      Nuevo token de acceso
      Nuevo token de acceso

    Enviar solicitudGET

    Ahora estamos listos para hacer solicitudes API.

    Hacer una solicitudGET

    1. Ahora introduce la siguiente URL en el campo Introducir URL de solicitud , sustituyendo tu ID de cuenta por {account_id}:
      	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
      	
      	
      Introducir URL de solicitud
      Introducir URL de solicitud
    2. Deje el método como y GET haga clic en Enviar:
      Obtener solicitud
      GET Solicitud
    3. La respuesta debería verse algo como esto:
      Respuesta GET
      Respuesta GET

    Enviar solicitudPOST

    Ahora enviaremos una POST solicitud con algunos datos. En este caso crearemos un nuevo reproductor usando la API de administración de jugadores.

    Hacer una solicitudPOST

    1. Duplica tu solicitud Get Players:
      Solicitud duplicada
      Solicitud duplicada
    2. Abra su nueva solicitud y cambie el nombre de «Crear reproductor»
      Cambiar nombre de solicitud
      Cambiar nombre de solicitud
    3. Utilice la misma URL que hizo para los pasos anteriores de GET solicitud, pero ahora elija POST ser el método HTTP seleccionado.
      Solicitud de publicación
      POST Solicitud
    4. Haga clic en la pestaña Cuerpo justo debajo de la URL, luego elija el botón de opción sin procesar y JSON (application/json) en el menú desplegable de tipos:
      Cuerpo de solicitud
      Cuerpo de solicitud
    5. Puede observar que un nuevo encabezado se agrega automáticamente a la solicitud. Las solicitudes que envían datos necesitan un encabezado que diga a la API qué tipo de datos se están enviando. Haga clic en la ficha Encabezados para ver el Content-Type: application/json encabezado:
      Agregar encabezado
      Agregar encabezado
    6. Para los datos sin procesar, ingrese 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": "Postman Test Player"
              }
      	
    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):

      Respuesta POST
      Respuesta POST
    9. Puede comprobar que el reproductor se creó marcando en la sección Reproductores de Studio.

    Variables de entorno

    Aunque puede crear credenciales de cliente para varias cuentas y cualquier combinación de operaciones de API, puede que desee mantener una mayor seguridad limitando el alcance de sus credenciales a una sola cuenta y API (o incluso operaciones específicas de API). Si es así, puedes aprovechar Postmanes Variables de entorno para simplificar las solicitudes de prueba en varias cuentas y API. La clave consiste en configurar entornos correspondientes a cada conjunto de credenciales de cliente que utilice.

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

    1. Haga clic en el menú de engranaje situado en la parte superior derecha Postman y seleccione Administrar entornos.
      Menú Ambientes
      Menú Ambientes
    2. En el cuadro de diálogo Administrar entornos , haga clic en Agregar para agregar un entorno.
    3. Para el nuevo entorno, escriba:
      • Un nombre (API de Brightcove, o lo que quieras)
      • Una variable de entorno llamada account_id con un valor de su ID de cuenta
      • Una variable de entorno llamada client_id con un valor de su ID de cliente
      • Una variable de entorno llamada client_secret con un valor del secreto de su cliente
      Agregar variables de entorno
      Agregar variables de entorno
    4. Haga clic en Agregar para agregar el entorno
    5. Cierre el cuadro de diálogo Administrar entornos para volver al entorno Postman y seleccionarlo en el menú.
      Seleccionar un entorno
      Seleccionar un entorno
    6. Ahora puede comenzar a reemplazar valores codificados en sus solicitudes con variables. Para hacerlo, simplemente escriba {{ en cualquier lugar, y aparecerá una lista desplegable de variables:
      Usar variables de entorno
      Usar variables de entorno

    Crear una colección a partir de una referencia API

    A partir de la versión 6.7.4, Postman admite la importación de especificaciones OpenAPI para crear colecciones de solicitudes. Dado que las referencias de API de la plataforma de Brightcove se basan en la especificación OpenAPI, puede utilizar esta función para generar una colección completa de solicitudes para cualquiera de las API de Brightcove.

    En los pasos a continuación, utilizaremos el Dynamic Ingest API como ejemplo, pero el procedimiento funcionará para cualquiera de las API de la plataforma Brightcove (no para Player API o los SDK móviles, porque Postman solo admite API REST).

    Pasos

    1. En su navegador, vaya a Referencia de API de ingesta dinámica
    2. Haga clic en el Download botón debajo del título para descargar el OpenAPI specification para la API:
      Descargue la especificación OpenAPI
      Descargue la especificación OpenAPI
    3. Dependiendo del navegador que esté utilizando, la especificación (un archivo YAML) puede descargarse o abrirse en una nueva pestaña del navegador. Si se abre en el explorador, copie y pegue el contenido en un archivo de texto o guarde el origen de la página en la unidad local. El archivo debe ser nombrado openapi.yaml.
    4. Ahora vaya a Postman y haga clic en el Import botón situado en la parte superior de la ventana en el lado izquierdo:
      Botón Importar Cartero
      Botón Importar Cartero
    5. Arrastre y suelte el openapi.yaml archivo desde el gestor de archivos en el modal de importación que se abre:
      Modal de importación de cartero
      Modal de importación de cartero
    6. Después de Postman procesar el archivo, verá una nueva colección en la lista titulada Dynamic Ingest API Reference
      Nueva Colección Cartero
      Nueva Colección Cartero
    7. Desplegar detalles en las carpetas a través accounts/{account id}/video/{video id} y verá las solicitudes:
      Desenlaje a las solicitudes
      Desenlaje a las solicitudes
    8. Seleccione la POST solicitud para abrirla. Encontrará tanto el Params como el Body rellenado previamente de la referencia API, pero deberá reemplazar los marcadores de posición que muestran el tipo de datos con datos reales:
      Paráms rellenados previamente
      Paráms rellenados previamente
      Cuerpo rellenado previamente
      Cuerpo rellenado previamente
    9. Una vez que haya reemplazado los marcadores de posición con los valores apropiados, puede usar la solicitud igual que los que creó usted mismo.

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