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

Use 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 que las declaraciones curl y la línea de comando, utilizadas para la mayoría de los ejemplos en esta sección de la documentación, 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 de esas herramientas, la aplicación Postman.

Instalar Postman

Get 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.

Obtenga las credenciales del cliente

Para trabajar con 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 Postman, por lo que sus credenciales deben tener al menos los siguientes permisos:

  • Players: Read/Write

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 obtendrá credenciales que funcionarán para varias cuentas si lo desea.

Puedes usar esta aplicación en línea si tu prefieres. Si lo hace, debe especificar al menos video-cloud/player/all permisos

Usar Postman

Una vez que tenga sus credenciales de cliente, estará listo para comenzar a usar Postman. Los pasos a continuación te guiarán a través de hacer algunas Player Management API solicitudes de uso Postman.

Configuración Postman para obtener tokens de acceso

  1. Inicie el Postman aplicación.
  2. Crea una nueva solicitud:
    Crear nueva solicitud
    Crear nueva solicitud
  3. En el nuevo cuadro de diálogo de solicitud, ingrese "Obtener Players "para el nombre de la solicitud:
    Nombre de solicitud
    Nombre de solicitud
  4. Haga clic en Crear colección y luego ingrese "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. Encuentra el Player Management API en la lista de la izquierda y haga clic en ella para abrir su nueva solicitud:
    Player Management API Colección
    Player Management API Colección
  7. Vaya al Autorización pestaña, elija OAuth 2.0 como tipo y asegúrese de seleccionar Agregar datos de autorización a los encabezados de solicitud:
    Sección de Autorización
    Sección de Autorización
  8. Oprima Obtener un nuevo token de acceso:
    Obtener un nuevo token de acceso
    Obtener un nuevo token de acceso
  9. En el cuadro de diálogo, ingrese la siguiente información:
    • Nombre del token: Player Management API
    • Tipo de beca: Credenciales del cliente
    • URL de token de acceso: https://oauth.brightcove.com/v4/access_token
    • ID de cliente: (ingrese su identificación de cliente)
    • Secreto del cliente: (ingrese su secreto de cliente)
    • Alcance: (déjalo en blanco)
    • Autenticación del cliente: Enviar credenciales de cliente en el cuerpo
    Obtener el cuadro de diálogo Token de acceso
    Obtener el cuadro de diálogo Token de acceso
  10. Oprima Token de solicitud
  11. Debería ver aparecer un nuevo token de acceso:
    Nuevo token de acceso
    Nuevo token de acceso

Enviar GET solicitar

Ahora estamos listos para hacer solicitudes de API.

Haz una GET solicitar

  1. Ahora ingrese la siguiente URL en el Ingrese la URL de solicitud campo, sustituyendo el ID de su cuenta por {account_id}:
    	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
    	
    	
    Ingrese la URL de solicitud
    Ingrese la URL de solicitud
  2. Deja el método como GETY haga clic en Enviar:
    Obtener Solicitud
    GET Solicitar
  3. La respuesta debería verse más o menos así:
    Obtener una respuesta
    Obtener una respuesta

Enviar POST solicitar

Ahora le enviaremos un POST solicitud con algunos datos. En este caso crearemos un nuevo player usando el Player Management API.

Haz una POST solicitar

  1. Duplica tu Get Players solicitud:
    Solicitud duplicada
    Solicitud duplicada
  2. Abra su nueva solicitud y cámbiele el nombre "Crear Player"
    Renombrar solicitud
    Renombrar solicitud
  3. Use la misma URL que usó para la GET Solicita los pasos anteriores, pero ahora elige POST ser el método HTTP seleccionado.
    Publicar solicitud
    POST Solicitar
  4. Haga clic en el Cuerpo pestaña justo debajo de la URL, luego elija la crudo botón de radio y JSON (aplicación / json) del menú desplegable tipo:
    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 indique a la API qué tipo de datos se envían. Haga clic en el Encabezados pestaña para ver el Content-Type: application/json encabezamiento:
    Agregar encabezado
    Agregar encabezado
  6. Para los datos brutos, ingrese el siguiente código JSON para el cuerpo (la captura de pantalla que sigue a JSON muestra cómo debería aparecer la solicitud):
    	{
            "name": "Postman Test Player"
            }
    	
  7. Oprima Enviar.
  8. Su respuesta será similar a la siguiente (Puede hacer clic en Bonita botón para JSON con el mejor formato):

    Respuesta POST
    Respuesta POST
  9. Puedes verificar que tu player fue creado al registrar el Players sección de Studio.

Variables de entorno

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

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

  1. Haga clic en el menú de engranajes en la parte superior derecha Postman y seleccionar Administrar entornos.
    Menú de ambientes
    Menú de ambientes
  2. En la sección que pone Administrar entornos diálogo, haga clic Añadir para agregar un ambiente.
  3. Para el nuevo entorno, ingrese:
    • Un nombre (Brightcove APIS, o lo que quieras)
    • Una variable de entorno llamada account_id con un valor de identificación de su 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 de secreto de su cliente
    Agregar variables de entorno
    Agregar variables de entorno
  4. Oprima Añadir para agregar el ambiente
  5. Cierra el Administrar entornos diálogo para volver a Postman y seleccione su entorno desde el menú.
    Seleccione un Entorno
    Seleccione un entorno
  6. Ahora puede comenzar a reemplazar valores codificados en sus solicitudes con variables. Para hacerlo, solo escribe {{ En cualquier lugar, y aparecerá una lista desplegable de variables:
    Utilizar variables de entorno
    Utilizar 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 de OpenAPI para crear colecciones de solicitudes. Dado que las referencias de API de 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 idea Player API o los SDK móviles, porque Postman solo admite API REST).

Pasos

  1. En su navegador, vaya a Dynamic Ingest API Referencia
  2. Clickea en el Download botón debajo del título para descargar el OpenAPI specification para la API:
    Descargar la especificación de OpenAPI
    Descargar la especificación de OpenAPI
  3. Según el 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 navegador, copie y pegue el contenido en un archivo de texto o guarde la fuente de la página en su disco local. El archivo debe ser nombrado openapi.yaml.
  4. Ahora ve a Postman Y haga clic en el Import Botón en la parte superior de la ventana en el lado izquierdo:
    Botón de importación de cartero
    Botón de importación de cartero
  5. Arrastrar y soltar el openapi.yaml archivo de su administrador de archivos en el modal de importación que se abre:
    Postman Import Modal
    Postman Import Modal
  6. Después de Postman Procesa el archivo, verás una nueva Colección en la lista titulada Dynamic Ingest API Reference
    Nueva colección de carteros
    Nueva colección de carteros
  7. Desglosar en las carpetas a través de accounts/{account id}/video/{video id} y verás las peticiones:
    Desglose de solicitudes
    Desglose de solicitudes
  8. Seleccione el botón POST Solicitud para abrirlo. Va a encontrar tanto el Params y la Body rellenado previamente desde la referencia de la API, pero deberá reemplazar los marcadores de posición que muestran el tipo de datos con datos reales:
    Parámetros prepopulados
    Parámetros prepopulados
    Cuerpo prepopulado
    Cuerpo prepopulado
  9. Una vez que haya reemplazado los marcadores de posición con los valores apropiados, puede usar la solicitud tal como los creó usted mismo.

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