VocalStack Logo

Documentation

Pridobi podatke o prepisu

Pridobite podatke iz čakajočih ali dokončanih prepisov

Prepis iz mikrofona ali LiveStream

Prepisujte govor v živo iz mikrofona ali pretoka v živo

Seje za prepisovanje

Spremljajte in upravljajte stanje prepisa s sejami

Prevedi prepis

Prevedite prepisano besedilo v drug jezik

Prepisovanje zvoka iz URL-ja

Prepis govora iz predhodno posnetega zvoka v URL v navadno besedilo

Žetoni za preverjanje pristnosti na strani odjemalca

Zahteva za prepis in odgovor

Skupne možnosti zahteve in odzivi za vse postopke prepisovanja

Prepis in predstavitev poliglotske seje

Ustvarite sejo, ki jo lahko uporabite za oddajanje prepisa v živo prek javne povezave za skupno rabo

Žetoni za preverjanje pristnosti na strani odjemalca

Brskanje po dokumentaciji
Ustvarite začasni žeton za preverjanje pristnosti za zahteve na strani odjemalca. Varno izvajajte zahteve API v spletnih brskalnikih, ne da bi razkrili svoje ključe API.
Žetoni za preverjanje pristnosti so bistveni varnostni ukrep v odjemalskih okoljih, kjer potrebujete storitve VocalStack API. To boste potrebovali, ko boste izvajali zahteve API v spletnih brskalnikih, aplikacijah ali drugih javnih okoljih.

Ustvarjanje žetona za preverjanje pristnosti

Na strani strežnika lahko uporabimo SDK za generiranje avtentikacijskega žetona. Privzeto so možnosti za žeton omejevalne. Morda boste želeli posodobiti te, da ustrezajo vašim zahtevam:
  • access: Bodisi "samo za branje" ali "za pisanje". Prvi vam omogoča izvajanje klicev API, ki vrnejo podatke. Slednji vam omogoča tudi izvajanje zahtev API, ki vključujejo zaračunane transkripcije, povezane z operacijami. Privzeta vrednost za to možnost je. "samo za branje".
  • lifetime_s: Število med 1 in 120, ki predstavlja življenjsko dobo žetona v sekundah. Po tem obdobju bo žeton potekel in ne bo več uporaben. To ne bo vplivalo na asinhronske zahteve, ki so že začele uporabljati ta žeton. (Z drugimi besedami, ko se začne asinhrona zahteva, se bo izvajala do konca, tudi če žeton poteče po začetku zahteve. ) Privzeta vrednost za to možnost je. 10.
  • one_time: Boolovska vrednost, ki označuje, ali je ta API žeton namenjen za enkratno uporabo. Če je true, bo ta žeton po uporabi za zahtevo API potekel. Privzeta vrednost za to možnost je. res.
Tukaj je, kako bo to izgledalo na vašem strežniku:
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.
Potrebovali boste namestitev mehanizma za posredovanje vašega strežnika, ki je ustvaril API žeton vašemu odjemalcu. To bo v veliki meri odvisno od vaše infrastrukture in tehnološkega niza. Poskrbite, da boste izvajali najboljše varnostne prakse. Ne smete na primer ustvariti končne točke API, ki zagotavlja ustvarjene žetone API za zahteve, katerih preverjanje pristnosti ni bilo opravljeno.

Uporaba žetona za preverjanje pristnosti

Poraba VocalStack API na strani odjemalca zahteva, da uporabite. authToken nastavitev namesto apiKey. Na primer, upoštevajte dokumentacijo za Prepisovanje zvoka iz URL-ja.
V tem primeru preprosto zamenjajte:
{ apiKey: 'YOUR-API-KEY' } z { authToken: 'YOUR-AUTH-TOKEN' } 6. izdaja.
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();

Varnostni vidiki

Pri ustvarjanju in zagotavljanju žetonov za preverjanje pristnosti na strani odjemalca je ključnega pomena, da izvedete stroge varnostne ukrepe, da preprečite nepooblaščen dostop do vašega API-ja. Žetoni so močna orodja za dostop do virov in storitev, in če niso zaščiteni, jih je mogoče zlorabiti. Zagotoviti morate, da lahko samo pooblaščeni odjemalci zahtevajo in uporabljajo žetone, in nikoli ne smete izpostavljati občutljivih podatkov, kot so ključi API, v javnem okolju. Če tega ne storite, lahko pride do kršitev varnosti podatkov, nepooblaščenega dostopa do virov ali nenamernih stroškov za zaračunane storitve.
Če želite zaščititi uvedbo, upoštevajte te najboljše prakse:
  • Nikoli ne izpostavljajte svojih API ključev na strani odjemalca: API ključi morajo vedno ostati zaupni in varno shranjeni na strežniku. Izpostavljanje jih v odjemalski strani kode (e. g. JavaScript, HTML) lahko privede do nepooblaščenega dostopa do API-ja.
  • Uporabite varno generiranje žetonov na strani strežnika: Vedno generiraj žetone za preverjanje pristnosti na strani strežnika, da preprečiš izpostavljanje ključev API v odjemalski kodi.
  • Preverjanje pristnosti zahtevkov za žetone: Zagotovite, da lahko samo preverjeni uporabniki ali storitve zahtevajo žeton API z uveljavljanjem mehanizmov preverjanja pristnosti (npr. g. , OAuth, potrjevanje seje).
  • Implementacija protokola HTTPS: Vedno služi žetone preko HTTPS za zaščito pred man-in-the-middle napadov.
  • Izogibajte se razkrivanju žetonov v URL-jih: Nikoli ne posredujte žetonov v parametrih URL poizvedbe, saj bi se lahko zapisali v strežniške dnevnike ali izpostavili v zgodovini brskalnika.
  • Omejitev obsega žetona: Omejite žetone na minimalno potrebno dovoljenje, kot je dostop samo za branje, razen če je izrecno zahtevan dostop za pisanje.
  • Nastavitev poteka žetona: Uporabite kratke življenjske dobe žetonov, da zmanjšate tveganje zlorabe žetonov. Razmislite o omejitvi življenjske dobe žetonov glede na vzorce uporabe in varnostne potrebe.
  • Omogočite žetone za enkratno uporabo: Če je mogoče, uporabite enkratne žetone za posebej občutljiva dejanja, da zagotovite, da jih ni mogoče ponovno uporabiti.
Scroll Up