Automate your video workflows with the Webgate.io API

The Webgate.io API allows you to seamlessly integrate powerful media management and automation into your existing workflows. Whether you need to upload, process and distribute large volumes of media files or manage complex post-production tasks, our API has you covered.

API features in a nutshell

Manage files and folders
Upload files and video material
Download files and video material
Read and write comments
Read and write metadata
Manage users and their permissions
Easy Swagger documentation

Webgate.io API Documentation

Getting started with the Webgate.io API

To ensure secure access to Webgate.io, your application must authenticate using OAuth (Open Authorization). OAuth is an industry-standard protocol that allows applications to interact with a service on behalf of a user without sharing their credentials. By issuing tokens, OAuth enables secure, scoped access to protected resources, ensuring that only authorized applications can perform certain actions. This process protects user data while granting the application the permissions it needs to operate within specified boundaries.

Create an OAuth App

To begin interacting with Webgate.io, you'll need to create an OAuth application. Start by navigating to your profile: click the user icon in the top-right corner and select your name. On your profile page, you'll find a context menu that provides options for managing your OAuth applications.

When creating an OAuth App you will be asked to enter the following data:

Name

The Name of your Application. It is supposed to be easily recognized by your users who are going to authorize your app.

Redirect URIs

The OAuth app allows you to specify multiple redirect URIs. Each of these URIs is used to integrate the OAuth app with a different application. For every URI you provide, a corresponding route is created in Webgate.io, which can be used to initiate the authorization process for a Webgate.io user with your app. After the user authorizes the app, they are redirected to the specific URI associated with that route.

Issue an Access Grant for your App

Once you have created an OAuth App, Webgate.io provides you with the following data to authorize:

Client ID

The Client ID is a unique identifier for an OAuth application that allows it to be recognized by the authorization server.

Client Secret

The Client Secret is a confidential key used by an OAuth application to authenticate itself with the authorization server, ensuring secure communication.

URLs

Each Redirect URI has a uniq Authorization URL which points to an endpoint where users are redirected to grant access to an application. These URLs handle user authentication and authorization, allowing the app to receive an authorization code. During development you can also create an code by clicking the «Generate» button in our interface.

To authenticate, send the Client ID, Client Secret and the Authorization Code to the token endpoint https://webgate.io/oauth/token. In return, you'll receive an access token, which you can use to make authorized API requests.

The authorization code is temporary and is exchanged for an access token, which grants long-term access to the protected resources. You include the access token in the headers (usually as a Bearer token) of subsequent API calls to access protected resources on behalf of the user.

The access token expires after a certain time and needs to be renewed. This is also done via the above mentioned token endpoint with grant_type refresh_token.

Make requests directly in the API Documentation

Webgate.io uses Swagger to provide a comprehensive interface for interacting with its API. Through the Swagger documentation, you can not only view all available API endpoints, but also execute requests directly from the interface. This makes it easy to test and explore the API's functionality.

To get started, you first need to obtain an access token using OAuth authentication. Once you have the token, you can use it to authenticate all subsequent API requests by including it in the Authorization header. This streamlines the process of interacting securely with the Webgate.io API.

Webgate.io API Documentation