Documentation

Preuzmi podatke o transkripciji

Dohvati podatke iz čekanja ili završenih transkripcija

Prepisivati iz mikrofona ili LiveStreama

Prepisivati govor uživo iz mikrofona ili live streama

Transkripcija

Nadzire i upravlja stanjem transkripcije sa seansama

Prevedi transkripciju

Prevodi transkripciju teksta na drugi jezik

Prepisivaj audio sa URL-a

Pretvara govor iz prethodno snimljenog zvuka u URL u obični tekst

Zahtjev za prepisivanje i odgovor

Opcije zajedničkog zahtjeva i odgovora za sve operacije prepisa

Prepisivati i prezentirati poliglotsku sesiju

Napravite sesiju koja se može koristiti za emitiranje transkripcije uživo putem javne poveznice za dijeljenje

Tokeni za provjeru autentičnosti na strani klijenta

Pregledaj dokumentaciju
Napravi privremeni token za provjeru autentičnosti za zahtjeve sa strane klijenta. Sigurno implementirajte API zahtjeve u web preglednicima bez izlaganja vaših API ključeva.
Autentikacijski tokeni su neophodna sigurnosna mjera u klijentskim okruženjima gdje su potrebne VocalStack API usluge. Ovo će vam biti potrebno kada implementirate API zahtjeve u web preglednicima, aplikacijama ili bilo kojem drugom javnom okruženju.
Na serverskoj strani možemo koristiti SDK da generiramo autentifikacijski token. Prema standardnim postavkama, opcije za token su restriktivne. Možda ćete htjeti da ih ažurirate da odgovaraju vašim zahtjevima:
  • access: Ili "samo za čitanje" ili "zapisivanje". Prvi vam omogućava da izvršite API pozive koji vraćaju podatke. Ovo vam također omogućava da izvršite API zahtjeve koji uključuju naplative transkripcijske operacije. Uobičajena vrijednost za ovu opciju je. "samo za čitanje".
  • lifetime_s: Broj između 1 i 120 koji predstavlja životni vijek žetona u sekundama. Nakon tog perioda, token će isteći i više neće biti upotrebljiv. Napomena: Ovo neće utjecati na asinkrone zahtjeve koji su već počeli koristiti ovaj token. (U slučaju da je u pitanju samo jedan od ovih uvjeta, onda se vrši prebrojavanje, a ako je više od jednog, onda se vrši zbrajanje.) ) Uobičajena vrijednost za ovu opciju je. 10.
  • one_time: Boolean koji označava da li je ovaj API token namijenjen za jednokratnu upotrebu. Ako je istinit, nakon što je ovaj token korišten za API zahtjev, on će isteći. Uobičajena vrijednost za ovu opciju je. Istina.
Evo kako će ovo izgledati na vašem serveru:
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.
Morat ćete postaviti mehanizam za posluživanje vašeg servera generiranog API tokena vašem klijentu. To će uveliko zavisiti od vaše infrastrukture i tehnološkog stoga. Pobrinite se da provedete najbolje sigurnosne prakse. Naprimjer, ne biste trebali kreirati API krajnju tačku koja služi generiranim API tokenima za neautentificirane zahtjeve.
Konzumiranje VocalStack API-ja na klijentskoj strani zahtijeva da koristite. authToken setting instead of an apiKey. Naprimjer, razmotrite dokumentaciju za Prepisivaj audio sa URL-a.
U ovom primjeru jednostavno zamijenite:
{ apiKey: 'YOUR-API-KEY' } with { 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();
U slučaju da se radi o neovlaštenom pristupu, potrebno je poduzeti mjere opreza kako bi se spriječio neovlašteni pristup. Tokeni su moćna sredstva za pristup resursima i uslugama, a ako nisu zaštićeni, mogu se zloupotrijebiti. Morate osigurati da samo ovlašteni klijenti mogu zatražiti i koristiti tokene, i nikada ne biste trebali izlagati osjetljive podatke kao što su API ključevi u javnom okruženju. Neuspješno izvršavanje ovog zahtjeva može rezultirati u kršenju podataka, neovlaštenom pristupu resursima ili nenamjernim naplatima za usluge koje se obračunavaju.
Da biste pomogli u osiguravanju svoje implementacije, razmotrite sljedeće najbolje prakse:
  • Nikad ne izlaži svoje API ključeve na klijentskoj strani: API ključevi bi uvijek trebali ostati povjerljivi i sigurno pohranjeni na serveru. Uključuje ih u klijent-side kod (e. g. JavaScript, HTML) može dovesti do neovlaštenog pristupa API-ju.
  • Koristi sigurno generiranje tokena na strani servera: Uvijek generirajte autentifikacijske tokene na serverskoj strani kako biste spriječili izlaganje API ključeva u klijentskom kodu.
  • Zahtjevi za autentifikaciju za tokene: Osigurati da samo autentificirani korisnici ili usluge mogu zatražiti API token primjenom autentifikacijskih mehanizama (e.g. g. , OAuth, session validation).
  • Implementacija HTTPS: Uvijek posluži tokene preko HTTPS-a kako bi zaštitio od napada čovjeka u sredini.
  • Izbjegavaj prikazivanje tokena u URL-ovima: Nikad ne predajte tokene u URL parametrima upita jer bi mogli biti zabilježeni u serverskim zapisima ili izloženi u historiji preglednika.
  • Ograniči opseg tokena: Ograničiti tokene na minimalno neophodne dozvole, kao što je pristup samo za čitanje, osim ako nije eksplicitno potreban pristup za pisanje.
  • Postavite vrijeme isteka token-a: Korištenje kratkih životnih vijekova tokena za smanjenje rizika od zloupotrebe tokena. Razmislite o ograničenju životnog vijeka tokena na osnovu uzoraka upotrebe i sigurnosnih potreba.
  • Omogući jednokratne tokene: Ako je moguće, koristite jednokratne žetone za posebno osjetljive akcije kako biste bili sigurni da ih ne možete ponovno koristiti.
Scroll Up