VocalStack Logo

Documentation

Ottieni dati di trascrizione

Ottieni dati da trascrizioni in sospeso o completate

Trascrizione da un microfono o LiveStream

Trascrivi il discorso dal vivo da un microfono o da un live stream

Sessioni di trascrizione

Monitorare e gestire lo stato della trascrizione con le sessioni

Tradurre una Trascrizione

Traduci il testo trascritto in un'altra lingua

Trascrivere Audio da URL

Trascrivi il discorso dall'audio preregistrato in un URL in testo normale

Token di autenticazione lato client

Richiesta e risposta di trascrizione

Opzioni e risposte comuni per tutte le operazioni di trascrizione

Trascrivere e presentare una sessione poliglotta

Creare una sessione che può essere utilizzata per trasmettere una trascrizione dal vivo tramite un link condivisibile pubblico

Token di autenticazione lato client

Sfoglia la documentazione
Crea un token di autenticazione temporaneo per le richieste lato client. Implementa in modo sicuro le richieste API nei browser Web senza esporre le chiavi API.
I token di autenticazione sono una misura di sicurezza essenziale negli ambienti client in cui sono richiesti i servizi API VocalStack. Questo è necessario quando si implementano richieste API in browser Web, app o altri ambienti pubblici.

Generazione di un token di autenticazione

Sul lato server possiamo usare l'SDK per generare un token di autenticazione. Per impostazione predefinita, le opzioni per il token sono restrittive. Potresti voler aggiornare questi per soddisfare le tue esigenze:
  • access: "solo lettura" o "lettura-scrittura". Il primo consente di eseguire chiamate API che restituiscono dati. Quest'ultimo consente anche di eseguire richieste API che includono operazioni relative alla trascrizione fatturabile. Il valore predefinito per questa opzione è. "solo per lettura".
  • lifetime_s: Un numero compreso tra 1 e 120 che rappresenta la durata del token in secondi. Dopo questo periodo, il token scadrà e non sarà più utilizzabile. Si noti che questo non influirà sulle richieste asincrone che hanno già iniziato a utilizzare questo token. (In altre parole, una volta avviata una richiesta asincrona, verrà eseguita fino al completamento anche se il token è scaduto dopo l'avvio della richiesta. ) Il valore predefinito per questa opzione è. 10.
  • one_time: Un booleano che indica se questo token API è destinato ad un singolo uso. Se è true, una volta che questo token è stato usato per una richiesta API, scadrà. Il valore predefinito per questa opzione è. vero.
Ecco come apparirà sul tuo server:
JavaScript
import { Security } from '@vocalstack/js-sdk';

const sdk = new Security({ apiKey: 'YOUR-API-KEY' });

const authToken = await sdk.generateToken({
  access: 'readwrite', // Optional: 'readonly' or 'readwrite'
  lifetime_s: 60, // Optional: 1-120 seconds
  one_time: true, // Optional: true or false
});

// Next, return the token to the client where API request will be made.
// Make sure to keep the token secure and do not expose it to the public.
Dovrai impostare un meccanismo per servire il token API generato dal server al tuo client. Questo dipenderà in gran parte dalla vostra infrastruttura e dal vostro stack tecnologico. Assicurati di implementare le migliori pratiche di sicurezza. Ad esempio, non è consigliabile creare un endpoint API che fornisca token API generati a richieste non autenticate.

Utilizzo di un token di autenticazione

L'utilizzo dell'API VocalStack sul lato client richiede l'utilizzo di un. authToken impostazione al posto di un apiKey. Ad esempio, considera la documentazione per Trascrivere Audio da URL.
In questo esempio, sostituisci semplicemente:
{ apiKey: 'YOUR-API-KEY' } con { authToken: 'YOUR-AUTH-TOKEN' } 6.
JavaScript
import { UrlTranscription } from '@vocalstack/js-sdk';

const authToken = await fetch('http://example.com/your-secured-api/authenticate')
  .then((response) => response.json())
  .then((data) => data.token);

const sdk = new UrlTranscription({ authToken });
const transcription = await sdk.connect({ url: 'http://example.com/speech.mp3' });

transcription.start();

Considerazioni di sicurezza

Quando si generano e vengono forniti token di autenticazione lato client, è fondamentale implementare misure di sicurezza rigorose per impedire l'accesso non autorizzato alle API. I token sono strumenti potenti per accedere a risorse e servizi, e se non sono protetti, possono essere utilizzati in modo improprio. È necessario assicurarsi che solo i client autorizzati possano richiedere e utilizzare i token e non si dovrebbero mai esporre dati sensibili come le chiavi API in un ambiente pubblico. In caso contrario, potrebbero verificarsi violazioni dei dati, accessi non autorizzati alle risorse o addebiti involontari per servizi fatturabili.
Per proteggere l'implementazione, considera le seguenti best practice:
  • Non esporre mai le chiavi API sul lato client: Le chiavi API devono sempre rimanere riservate e devono essere archiviate in modo sicuro sul server. Esponendoli nel codice lato client (e.g. g. JavaScript, HTML) può portare ad un accesso non autorizzato all'API.
  • Utilizzare la generazione di token sicuri sul lato server: Generare sempre token di autenticazione sul lato server per evitare l'esposizione delle chiavi API nel codice client.
  • Autenticare le richieste di token: Assicurati che solo gli utenti o i servizi autenticati possano richiedere un token API applicando meccanismi di autenticazione (ad es. g. , OAuth, convalida della sessione).
  • Implementare il HTTPS: Servire sempre i token su HTTPS per proteggersi dagli attacchi man-in-the-middle.
  • Evitare di esporre i token negli URL: Non passare mai token nei parametri di query URL in quanto potrebbero essere registrati nei log del server o esposti nella cronologia del browser.
  • Limitare l'ambito del token: Limitare i token ai permessi minimi necessari, come l'accesso in sola lettura a meno che l'accesso in scrittura non sia esplicitamente richiesto.
  • Imposta scadenza del token: Utilizzare token a vita breve per ridurre il rischio di abuso di token. Considera la possibilità di limitare la durata dei token in base ai modelli di utilizzo e alle esigenze di sicurezza.
  • Abilita i token di uso singolo: Se possibile, usare token monouso per azioni particolarmente sensibili per assicurarsi che non possano essere riutilizzati.
Scroll Up