VocalStack Logo

Documentation

Získať údaje o prepise

Získať údaje z čakajúcich alebo dokončených prepisov

Prepis z mikrofónu alebo LiveStream

Prepisujte živú reč z mikrofónu alebo živého prenosu

Transkripčné relácie

Monitorovať a spravovať stav prepisu s reláciami

Preložiť prepis

Preložiť prepísaný text do iného jazyka

Prepis zvuku z URL

Prepis reči z vopred nahratého zvuku v URL na obyčajný text

Žiadosť o prepis a odpoveď

Spoločné možnosti žiadosti a odpovede pre všetky operácie prepisu

Prepis a prezentácia polyglotovej relácie

Vytvorte reláciu, ktorá môže byť použitá na vysielanie živého prepisu prostredníctvom verejného zdieľaného odkazu

Tokeny overenia na strane klienta

Prehľadávať dokumentáciu
Vytvoriť dočasný token overenia pre požiadavky na strane klienta. Bezpečne implementujte požiadavky API vo webových prehliadačoch bez toho, aby ste zverejnili svoje kľúče API.
Autentifikačné tokeny sú základným bezpečnostným opatrením v klientskych prostrediach, kde vyžadujete služby VocalStack API. Toto budete potrebovať pri implementácii požiadaviek API vo webových prehliadačoch, aplikáciách alebo iných verejných prostrediach.
Na strane servera môžeme použiť SDK na generovanie auth tokenu. V predvolenom nastavení sú možnosti pre token obmedzujúce. Možno budete chcieť aktualizovať tieto podľa vašich požiadaviek:
  • access: Buď "len na čítanie" alebo "na čítanie a zápis". Prvý z nich vám umožňuje vykonávať volania API, ktoré vracajú dáta. Druhá možnosť vám umožňuje vykonávať aj požiadavky API, ktoré zahŕňajú operácie súvisiace s účtovateľným prepisom. Predvolená hodnota pre túto možnosť je. "len na čítanie".
  • lifetime_s: Číslo medzi 1 a 120 predstavujúce životnosť tokenu v sekundách. Po uplynutí tejto doby token vyprší a už nebude použiteľný. Všimnite si, že to nebude mať vplyv na asynchrónne požiadavky, ktoré už začali používať tento token. (Inými slovami, po spustení asynchrónnej požiadavky sa spustí až do dokončenia, aj keď po spustení požiadavky vypršala platnosť tokenu. ) Predvolená hodnota pre túto možnosť je. 10.
  • one_time: Boolovská hodnota označujúca, či je tento token API určený na jednorazové použitie. Ak je hodnota true, po použití tohto tokenu pre požiadavku API vyprší jeho platnosť. Predvolená hodnota pre túto možnosť je. pravda.
Tu je návod, ako to bude vyzerať na vašom serveri:
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.
Budete musieť nastaviť mechanizmus pre poskytovanie tokenu API generovaného vaším serverom vášmu klientovi. To bude do značnej miery závisieť od vašej infraštruktúry a technologického zásobníka. Uistite sa, že implementujete najlepšie bezpečnostné postupy. Nemali by ste napríklad vytvárať koncový bod rozhrania API, ktorý poskytuje generované tokeny rozhrania API na neoverené požiadavky.
Konzumácia VocalStack API na strane klienta vyžaduje, aby ste použili. authToken nastavenie namiesto apiKey. Pozrime sa napríklad na dokumentáciu pre Prepis zvuku z URL.
V tomto príklade jednoducho nahraďte:
{ apiKey: 'YOUR-API-KEY' } with { authToken: 'YOUR-AUTH-TOKEN' } 6. vyd.
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();
Pri generovaní a poskytovaní autentifikácie tokenov na strane klienta je nevyhnutné implementovať prísne bezpečnostné opatrenia, aby sa zabránilo neoprávnenému prístupu k vášmu API. Tokeny sú mocnými nástrojmi na prístup k zdrojom a službám a ak nie sú chránené, môžu byť zneužité. Musíte zabezpečiť, aby mohli tokeny vyžadovať a používať len autorizovaní klienti, a nikdy by ste nemali zverejňovať citlivé údaje, ako sú kľúče API vo verejnom prostredí. Ak tak neurobíte, môže to mať za následok porušenie ochrany údajov, neoprávnený prístup k zdrojom alebo neúmyselné poplatky za služby, ktoré sa majú účtovať.
Ak chcete zabezpečiť implementáciu, zvážte nasledujúce osvedčené postupy:
  • Nikdy nevystavujte svoje API kľúče na strane klienta: API kľúče by mali zostať vždy dôverné a bezpečne uložené na serveri. Vystavenie ich v klientskom kóde (napr. g JavaScript, HTML) môže viesť k neoprávnenému prístupu k API.
  • Použitie generovania zabezpečených tokenov na strane servera: Vždy generovať autentifikačné tokeny na strane servera, aby sa zabránilo odhaleniu kľúčov API v klientskom kóde.
  • Overiť žiadosti o tokeny: Zabezpečte, aby mohli požiadať o token API iba overení používatelia alebo služby, a to vynucovaním mechanizmov overovania (napr. g. , OAuth, validácia relácie).
  • Implementácia protokolu HTTPS: Vždy poskytovať tokeny cez HTTPS na ochranu proti útokom typu man-in-the-middle.
  • Vyhnite sa zobrazovaniu tokenov v adresách URL: Nikdy nepredávajte tokeny v parametroch URL dotazu, pretože by mohli byť zaznamenané v protokoloch servera alebo vystavené v histórii prehliadača.
  • Obmedziť rozsah tokenu: Obmedzte tokeny na minimum potrebných oprávnení, ako je prístup iba na čítanie, pokiaľ nie je explicitne požadovaný prístup na zápis.
  • Nastaviť vypršanie platnosti tokenu: Používanie krátkych životností tokenov na zníženie rizika zneužitia tokenov. Zvážte obmedzenie životnosti tokenov na základe spôsobov používania a potrieb zabezpečenia.
  • Povolenie jednorazových tokenov: Ak je to možné, používajte jednorazové tokeny pre obzvlášť citlivé akcie, aby ste sa uistili, že ich nemožno znovu použiť.
Scroll Up