VocalStack Logo

Documentation

Obțineți date de transcriere

Obțineți date din transcrieri în așteptare sau finalizate

Transcrierea de la un microfon sau LiveStream

Transcrieți vorbirea în direct de la un microfon sau de la un flux live

Sesiuni de transcriere

Monitorizați și gestionați starea transcrierii cu sesiuni

Traduceți o transcriere

Traduceți textul transcris într-o altă limbă

Transcrie audio de la URL

Transcrieți vorbirea din audio preînregistrat într-un URL în text simplu

Cerere de transcriere și răspuns

Opțiuni de solicitare și răspunsuri comune pentru toate operațiunile de transcriere Utilizați opțiunile pentru a configura setările de transcriere

Transcrie și prezintă o sesiune poliglotă

Creați o sesiune care poate fi folosită pentru a difuza o transcriere în direct printr-un link public partajat

Token-uri de autentificare pe partea clientului

Răsfoiți documentația
Creează un token de autentificare temporar pentru solicitările de pe partea clientului. Implementați în siguranță solicitările API în browserele web fără a expune cheile API.
Token-urile de autentificare sunt o măsură esențială de securitate în mediile client unde aveți nevoie de serviciile VocalStack API. Veți avea nevoie de acest lucru atunci când implementați solicitări API în browsere web, aplicații sau orice alte medii publice.
Pe partea de server putem folosi SDK-ul pentru a genera un token de autentificare. În mod implicit, opțiunile pentru token sunt restrictive. Poate doriți să actualizați aceste pentru a se potrivi cerințelor dumneavoastră:
  • access: Fie "doar-citire" fie "citire-scriere". Primul vă permite să executați apeluri API care returnează date. Acesta din urmă vă permite să executați și solicitări API care includ operațiuni legate de transcriere facturabile. Valoarea implicită pentru această opțiune este. "doar pentru citire".
  • lifetime_s: Un număr între 1 și 120 reprezentând durata de viață a token-ului în secunde. După această perioadă, token-ul va expira și nu va mai fi utilizabil. Rețineți că acest lucru nu va afecta cererile asincrone care au început deja să utilizeze acest token. (Cu alte cuvinte, odată ce o solicitare asincronă a început, va rula până la finalizare, chiar dacă token-ul a expirat după ce solicitarea a început. ) Valoarea implicită pentru această opțiune este. 10.
  • one_time: Un boolean care indică dacă acest token API este destinat unei singure utilizări. Dacă este adevărat, odată ce acest token a fost folosit pentru o cerere API, acesta va expira. Valoarea implicită pentru această opțiune este. adevărat.
Iată cum va arăta pe serverul tău:
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.
Va trebui să configurați un mecanism pentru a servi token-ul API generat de server către client. Acest lucru va depinde în mare măsură de infrastructura și de tehnologia dvs. Asigurați-vă că implementați cele mai bune practici de securitate. De exemplu, nu trebuie să creați un punct final API care servește tokenuri API generate pentru solicitările neautentificate.
Consumarea API-ului VocalStack pe partea clientului necesită utilizarea unui. authToken setarea în loc de un apiKey. De exemplu, ia în considerare documentația pentru Transcrie audio de la URL.
În acest exemplu, înlocuiți pur și simplu:
{ apiKey: 'YOUR-API-KEY' } cu { 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();
Atunci când generați și serviți token-uri de autentificare pe partea clientului, este esențial să implementați măsuri de securitate stricte pentru a preveni accesul neautorizat la API-ul dvs. Token-urile sunt instrumente puternice pentru accesarea resurselor şi serviciilor, iar dacă nu sunt protejate, pot fi utilizate în mod abuziv. Trebuie să vă asigurați că numai clienții autorizați pot solicita și utiliza token-uri și nu ar trebui să expuneți niciodată date sensibile, cum ar fi cheile API într-un mediu public. Nerespectarea acestei obligații poate duce la încălcări ale securității datelor, acces neautorizat la resurse sau la taxe neintenționate pentru servicii facturabile.
Pentru a vă ajuta să vă securizați implementarea, luați în considerare următoarele practici recomandate:
  • Nu expuneți niciodată cheile API pe partea clientului: Cheile API trebuie să rămână întotdeauna confidențiale și să fie stocate în siguranță pe server. Expunerea lor în codul de pe partea clientului (e. g JavaScript, HTML) poate duce la acces neautorizat la API.
  • Utilizați generarea de tokenuri securizate pe partea serverului: Întotdeauna generați token-uri de autentificare pe partea de server pentru a preveni expunerea cheilor API în codul clientului.
  • Autentificați cererile pentru jetoane: Asigurați-vă că numai utilizatorii sau serviciile autentificate pot solicita un token API prin impunerea mecanismelor de autentificare (e. - Da. , OAuth, validarea sesiunii).
  • Implementați HTTPS: Servește întotdeauna token-uri prin HTTPS pentru a proteja împotriva atacurilor de tip man-in-the-middle.
  • Evitați expunerea tokenurilor în adresele URL: Nu treceți niciodată token-uri în parametrii de interogare URL, deoarece acestea ar putea fi înregistrate în jurnalele serverului sau expuse în istoricul browserului.
  • Restricționați domeniul de aplicare al tokenului: Limitarea token-urilor la permisiunile minime necesare, cum ar fi accesul doar în citire, cu excepția cazului în care accesul la scriere este necesar în mod explicit.
  • Setați expirarea tokenului: Folosiți durate de viață scurte ale token-urilor pentru a reduce riscul de utilizare abuzivă a token-urilor. Luați în considerare limitarea duratei de viață a token-ului pe baza modelelor de utilizare și a nevoilor de securitate.
  • Activați token-urile de unică folosință: Dacă este posibil, folosiți token-uri de unică folosință pentru acțiuni deosebit de sensibile pentru a vă asigura că acestea nu pot fi reutilizate.
Scroll Up