Automatizza i tuoi workflow video con l'API Webgate.io

L'API Webgate.io ti permette di integrare in modo fluido potenti funzioni di media management e automazione nei tuoi workflow esistenti. Che tu debba caricare, elaborare e distribuire grandi volumi di file media o gestire attività complesse di post-produzione, la nostra API ti supporta.

Funzionalità API in breve

Gestire file e cartelle
Caricare file e materiale video
Scaricare file e materiale video
Leggere e scrivere commenti
Leggere e scrivere metadati
Gestire utenti e relativi permessi
Documentazione Swagger semplice

Documentazione API Webgate.io

Primi passi con l'API Webgate.io

Per garantire un accesso sicuro a Webgate.io, la tua applicazione deve autenticarsi usando OAuth (Open Authorization). OAuth è un protocollo standard di settore che consente alle applicazioni di interagire con un servizio per conto di un utente senza condividere le sue credenziali. Emettendo token, OAuth consente un accesso sicuro e limitato per ambito alle risorse protette, assicurando che solo le applicazioni autorizzate possano eseguire determinate azioni. Questo processo protegge i dati degli utenti concedendo al tempo stesso all'applicazione i permessi necessari per operare entro limiti specificati.

Crea un'app OAuth

Per usare OAuth, occorre prima creare un'applicazione OAuth sul lato Webgate.io. Questo può essere fatto solo dal supporto Webgate.io.
Per richiederne la creazione, vai prima al tuo profilo: fai clic sull'icona utente in alto a destra e seleziona il tuo nome. Nella pagina del profilo troverai un menu contestuale che offre opzioni per gestire le tue applicazioni OAuth. Qui puoi inviare un messaggio al supporto Webgate.io per richiedere un'applicazione OAuth.
Devi fornire i seguenti dati:

Nome

Il nome della tua applicazione. Dovrebbe essere facilmente riconoscibile dagli utenti che autorizzeranno la tua app.

Proprietario

Indirizzo email del proprietario dell'applicazione.
Può essere un account diverso da quello che richiede l'applicazione.
L'applicazione OAuth e i suoi dati verranno mostrati solo in quell'account.

URI di redirect

Per ottenere un token di grant OAuth, la tua applicazione web deve chiamare l'endpoint token nell'applicazione Webgate.io, che reindirizza alla tua applicazione dopo che l'utente ha autorizzato l'applicazione. Per motivi di sicurezza, il redirect alla tua applicazione deve essere configurato sul lato Webgate.io. Possono esserci uno o più URI di redirect; l'URI di redirect da usare per una specifica chiamata di autorizzazione viene fornito come parametro redirect_url.
Se prevedi di usare l'API al di fuori di un'applicazione web (ad es. uno script), puoi lasciare questo campo vuoto.

Dati dell'applicazione OAuth

Una volta creata un'app OAuth, Webgate.io ti fornisce i seguenti dati per la tua applicazione OAuth:

Client Id

Il Client Id è un identificatore univoco per un'applicazione OAuth che le permette di essere riconosciuta dal server di autorizzazione.

Client Secret

Il Client Secret è una chiave riservata usata da un'applicazione OAuth per autenticarsi presso il server di autorizzazione, garantendo una comunicazione sicura.

URL di autorizzazione

Ogni URI di redirect ha un URL di autorizzazione univoco che punta a un endpoint verso cui gli utenti vengono reindirizzati per concedere l'accesso a un'applicazione. Questi URL gestiscono l'autenticazione e l'autorizzazione degli utenti, consentendo all'app di ricevere un codice di autorizzazione.

Per far autorizzare dall'utente la tua applicazione web ad accedere a Webgate.io, collega l'URL di autorizzazione. Quando l'utente segue questo link, deve autorizzare la tua applicazione ad accedere a Webgate.io. Poi viene reindirizzato alla tua applicazione usando il redirect url. Questo redirect passa un grant di accesso alla tua applicazione. Questo grant di accesso ha vita breve e deve essere scambiato con un token di accesso usando il token endpoint, che puoi usare per effettuare richieste API autorizzate. Includi il token di accesso negli header (di solito come Bearer token) delle chiamate API successive per accedere alle risorse protette per conto dell'utente. Il token di accesso ha comunque una durata limitata. Per l'accesso a lungo termine è necessario ottenere un refresh token (sempre tramite il token endpoint), che può essere usato per richiedere un nuovo token di accesso quando quello attuale scade.

Scorciatoia per l'uso in sviluppo, documentazione API e script

Sebbene OAuth offra un metodo definito per integrare applicazioni web, seguire l'intero processo può essere scomodo quando vuoi solo provare alcune chiamate API, usare la documentazione interattiva o usare l'API da uno script.
Per questo Webgate.io offre la possibilità di generare un grant di accesso e token di accesso e refresh usando il pulsante di generazione sotto gli URL di autorizzazione.
Il token di accesso può essere usato come bearer di autorizzazione nella documentazione Swagger o nelle richieste di test.
Il refresh token è adatto all'uso negli script. Prima di effettuare altre chiamate API, il refresh token deve essere usato per creare un token di accesso tramite il /oauth/token endpoint. Oltre al grant type "refresh_token" e al refresh token, devono essere forniti client id e client secret.
Tieni presente che refresh token e client secret devono essere mantenuti segreti per evitare accessi non autorizzati.

Effettua richieste direttamente nella documentazione API

Webgate.io usa Swagger per fornire un'interfaccia completa per interagire con la sua API. Attraverso la documentazione Swagger puoi non solo visualizzare tutti gli endpoint API disponibili, ma anche eseguire richieste direttamente dall'interfaccia. Questo rende semplice testare ed esplorare le funzionalità dell'API.

Per iniziare, devi prima ottenere un token di accesso usando l'autenticazione OAuth. Una volta ottenuto il token, puoi usarlo per autenticare tutte le richieste API successive includendolo nell'header Authorization. Questo semplifica il processo di interazione sicura con l'API Webgate.io.

Documentazione API Webgate.io