Automatisez vos workflows vidéo avec l'API Webgate.io

L'API Webgate.io vous permet d'intégrer de manière fluide une gestion des médias puissante et de l'automatisation dans vos workflows existants. Que vous ayez besoin de téléverser, traiter et distribuer de grands volumes de fichiers média ou de gérer des tâches complexes de postproduction, notre API répond à vos besoins.

Les fonctionnalités de l'API en bref

Gérer les fichiers et dossiers
Téléverser des fichiers et du matériel vidéo
Télécharger des fichiers et du matériel vidéo
Lire et écrire des commentaires
Lire et écrire des métadonnées
Gérer les utilisateurs et leurs autorisations
Documentation Swagger facile à utiliser

Documentation API Webgate.io

Bien démarrer avec l'API Webgate.io

Pour garantir un accès sécurisé à Webgate.io, votre application doit s'authentifier à l'aide d'OAuth (Open Authorization). OAuth est un protocole standard de l'industrie qui permet aux applications d'interagir avec un service au nom d'un utilisateur sans partager ses identifiants. En émettant des jetons, OAuth permet un accès sécurisé et limité à des ressources protégées, en garantissant que seules les applications autorisées peuvent effectuer certaines actions. Ce processus protège les données des utilisateurs tout en accordant à l'application les autorisations dont elle a besoin pour fonctionner dans des limites définies.

Créer une application OAuth

Pour utiliser OAuth, une application OAuth doit d'abord être créée côté Webgate.io. Cela ne peut être fait que par le support Webgate.io.

Pour demander cette création, commencez par accéder à votre profil : cliquez sur l'icône utilisateur en haut à droite et sélectionnez votre nom. Sur votre page de profil, vous trouverez un menu contextuel qui propose des options pour gérer vos applications OAuth. Vous pouvez y envoyer un message au support Webgate.io pour demander une application OAuth.

Vous devez fournir les données suivantes :

Nom

Le nom de votre application. Il doit être facilement reconnaissable par vos utilisateurs qui vont autoriser votre application.

Propriétaire

Adresse e-mail du propriétaire de l'application.
Il peut s'agir d'un autre compte que celui qui demande l'application.
L'application OAuth et ses données ne seront visibles que dans ce compte.

URI de redirection

Afin d'obtenir un jeton d'autorisation OAuth, votre application web doit appeler le point de terminaison des jetons dans l'application Webgate.io, qui redirige ensuite vers votre application après que l'utilisateur a autorisé l'application. Pour des raisons de sécurité, cette redirection vers votre application doit être configurée côté Webgate.io. Il peut y avoir une ou plusieurs URI de redirection ; l'URI de redirection à utiliser pour un appel d'autorisation spécifique est fournie comme paramètre redirect_url.

Si vous prévoyez d'utiliser l'API en dehors d'une application web (par ex. un script), vous pouvez laisser ce champ vide.

Données de l'application OAuth

Une fois votre application OAuth créée, Webgate.io vous fournit les données suivantes pour votre application OAuth :

Client Id

Le Client Id est un identifiant unique d'une application OAuth qui lui permet d'être reconnue par le serveur d'autorisation.

Client Secret

Le Client Secret est une clé confidentielle utilisée par une application OAuth pour s'authentifier auprès du serveur d'autorisation et garantir une communication sécurisée.

URL d'autorisation

Chaque URI de redirection possède une URL d'autorisation unique qui pointe vers un point de terminaison où les utilisateurs sont redirigés afin d'accorder un accès à une application. Ces URL gèrent l'authentification et l'autorisation des utilisateurs, ce qui permet à l'application de recevoir un code d'autorisation.

Pour faire autoriser à votre application web l'accès à Webgate.io par l'utilisateur, créez un lien vers l'URL d'autorisation. Lorsque l'utilisateur suit ce lien, il ou elle doit autoriser votre application à accéder à Webgate.io. Ensuite, il ou elle est redirigé vers votre application à l'aide de l'URL de redirection. Cette redirection transmet un accès accordé à votre application.

Cet accès accordé a une durée de vie courte et doit être échangé contre un jeton d'accès à l'aide du point de terminaison token, que vous pouvez utiliser pour effectuer des requêtes API autorisées.

Vous incluez le jeton d'accès dans les en-têtes (généralement comme jeton Bearer) des appels API suivants afin d'accéder à des ressources protégées au nom de l'utilisateur.

Le jeton d'accès a lui aussi une durée de vie limitée. Pour un accès à long terme, un jeton de rafraîchissement doit être obtenu (via le point de terminaison token également), afin de demander un nouveau jeton d'accès lorsque le jeton d'accès actuel expire.

Raccourci pour une utilisation en développement, dans la doc API et dans les scripts

Bien qu'OAuth fournisse une manière définie d'intégrer des applications web, il peut être fastidieux de suivre tout le processus lorsque vous souhaitez simplement essayer quelques appels API, utiliser la documentation interactive ou utiliser l'API depuis un script.

C'est pourquoi Webgate.io permet de générer un accès accordé ainsi que des jetons d'accès et de rafraîchissement à l'aide du bouton generate situé sous les URL d'autorisation.

Le jeton d'accès peut être utilisé comme autorisation bearer dans la documentation Swagger ou dans les requêtes de test.

Le jeton de rafraîchissement convient à une utilisation dans des scripts. Avant d'effectuer d'autres appels API, le jeton de rafraîchissement doit être utilisé pour créer un jeton d'accès via le point de terminaison /oauth/token. Envoyez le client id et le client secret en authentification HTTP Basic dans l'en-tête Authorization, et le grant type "refresh_token" ainsi que le jeton de rafraîchissement dans le corps de la requête. Jamais dans l'URL — les chaînes de requête finissent dans les journaux du serveur.

Gardez à l'esprit que le jeton de rafraîchissement et le client secret doivent rester secrets afin d'éviter tout accès non autorisé.

Faire des requêtes directement dans la documentation API

Webgate.io utilise Swagger pour fournir une interface complète permettant d'interagir avec son API. Grâce à la documentation Swagger, vous pouvez non seulement voir tous les points de terminaison API disponibles, mais aussi exécuter des requêtes directement depuis l'interface. Cela facilite le test et l'exploration des fonctionnalités de l'API.

Pour commencer, vous devez d'abord obtenir un jeton d'accès via l'authentification OAuth. Une fois ce jeton obtenu, vous pouvez l'utiliser pour authentifier toutes les requêtes API suivantes en l'incluant dans l'en-tête Authorization. Cela simplifie le processus d'interaction sécurisée avec l'API Webgate.io.

Documentation API Webgate.io