Automatiza tus flujos de trabajo de vídeo con la API de Webgate.io

La API de Webgate.io permite una integración fluida de una potente gestión de medios y automatización en tus flujos de trabajo existentes. Tanto si necesitas subir grandes cantidades de archivos multimedia, procesarlos y distribuirlos, como si quieres gestionar tareas complejas de posproducción, nuestra API te ofrece el soporte necesario.

Funciones de la API de un vistazo

  • Gestiona archivos y carpetas
  • Sube archivos y material de vídeo
  • Descarga archivos y material de vídeo
  • Lee y escribe comentarios
  • Lee y escribe metadatos
  • Gestiona usuarios y sus permisos
  • Documentación Swagger sencilla
Documentación de la API de Webgate.io

Primeros pasos con la API de Webgate.io

Para garantizar un acceso seguro a Webgate.io, tu aplicación debe utilizar OAuth (Open Authorization). OAuth es un estándar habitual del sector que permite a las aplicaciones interactuar con un servicio en nombre de un usuario sin revelar sus credenciales de acceso. Mediante la emisión de tokens, OAuth permite un acceso seguro y escalonado a recursos protegidos y garantiza que solo las aplicaciones autorizadas puedan ejecutar determinadas acciones. Este proceso protege los datos del usuario mientras concede a la aplicación los permisos necesarios dentro de límites definidos.

Página de perfil

Crea una aplicación OAuth

Para utilizar OAuth, primero debe crearse una aplicación OAuth en Webgate.io. Esto solo puede hacerlo el soporte de Webgate.io.
Para solicitar su creación, navega primero a tu perfil: haz clic en el icono de usuario en la esquina superior derecha y selecciona tu nombre. En tu página de perfil encontrarás un menú contextual que ofrece opciones para gestionar tus aplicaciones OAuth. Aquí puedes enviar un mensaje al soporte de Webgate.io para solicitar una aplicación OAuth.
Debes indicar los siguientes datos:

Nombre
El nombre de tu aplicación. Debería ser fácilmente reconocible para tus usuarios, que quieran autorizar tu aplicación.
Owner
Dirección de correo electrónico del usuario al que pertenece la aplicación.
Puede ser otra cuenta distinta de la que realiza la solicitud.
La aplicación OAuth y sus datos solo se mostrarán en la cuenta del owner.
URI de redirección

Para obtener un token de concesión OAuth, tu aplicación web debe llamar a un endpoint de token en la aplicación Webgate.io que, tras la autorización de la aplicación por parte del usuario, redirige de vuelta a tu aplicación. Por motivos de seguridad, el redirect a tu aplicación debe estar configurado en la parte de Webgate.io. Se puede indicar una o varias URI de redirección. La URI de redirección que debe utilizarse para una llamada de autorización concreta se indica como parámetro redirect_url.
Si solo quieres utilizar la API fuera de una aplicación web (por ejemplo, en un script), puedes dejar este parámetro vacío.

Otorga a tu aplicación permiso de acceso

En cuanto hayas creado una aplicación OAuth, Webgate.io te facilitará los siguientes datos para la autorización:

Client ID
El Client ID es un identificador único de una aplicación OAuth que permite que el servidor de autorización la reconozca.
Client Secret
El Client Secret es una clave confidencial utilizada por una aplicación OAuth para autenticarse ante el servidor de autorización y garantizar una comunicación segura.
URL de autorización
Cada URI de redirección tiene una URL de autorización única que apunta a un endpoint al que se redirige al usuario para conceder acceso a una aplicación. Estas URL gestionan la autenticación y autorización del usuario, de modo que la aplicación reciba un código de autorización.

Para que los usuarios puedan autorizar tu aplicación web para acceder a Webgate.io, enlazas a la URL de autorización. Cuando un usuario sigue este enlace, debe autorizar tu aplicación para el acceso a Webgate.io. A continuación, será redirigido a tu aplicación mediante la URL de redirección. En ese proceso se transmite a tu aplicación una concesión de acceso.
La concesión de acceso tiene una vida útil corta y debe convertirse mediante el endpoint de token de la API en un access token, que luego podrás utilizar para solicitudes API autorizadas.
Debes insertar el access token en la cabecera (normalmente como bearer token) de las llamadas API posteriores para acceder a recursos protegidos en nombre del usuario.
El access token también tiene una vida útil limitada. Para un acceso a largo plazo, debe solicitarse un refresh token (también a través del endpoint de token), con el que puede pedirse un nuevo access token cuando el access token actual caduque.

Página de perfil

Atajo para su uso en desarrollo, documentación de la API y scripts

Aunque OAuth favorece una vía predefinida para la integración de aplicaciones web, puede resultar molesto seguirla si solo se quieren probar algunas llamadas API, utilizar la documentación interactiva o usar la API en un script.
Por eso, Webgate.io ofrece generar un access grant y access y refresh tokens mediante un botón bajo las URL de autorización.
El access token puede utilizarse como bearer de autorización en la documentación swagger o en llamadas de prueba.
El refresh token puede utilizarse en scripts. Antes de realizar llamadas API, debe convertirse con ayuda del endpoint /oauth/token en un access token. Para ello, además del tipo de grant "refresh_token" y el refresh token, también hay que indicar el Client ID y el Client Secret.
Recuerda que el refresh token y el Client Secret deben mantenerse confidenciales para impedir accesos no autorizados.

documentación de la API swagger

Envía solicitudes directamente en la documentación de la API

Webgate.io utiliza Swagger para proporcionar una interfaz completa para interactuar con su API. A través de la documentación Swagger no solo puedes ver todos los endpoints de API disponibles, sino también ejecutar solicitudes directamente desde la interfaz. Esto facilita las pruebas y la exploración de las funciones de la API.

Para empezar, primero debes obtener un access token mediante la autenticación OAuth. En cuanto tengas el token, puedes usarlo para autenticar todas las demás solicitudes API insertándolo en la cabecera de autorización. Esto simplifica la interacción segura con la API de Webgate.io.

Documentación de la API de Webgate.io