VocalStack Logo

Documentation

Iegūt transkripcijas datus

Iegūt datus no gaidošām vai pabeigtām transkripcijām

Transkripts no mikrofona vai LiveStream

Transcribe tiešraides runu no mikrofona vai tiešraides straumi

Transkripcijas sesijas

Uzraudzīt un pārvaldīt transkripcijas statusu ar sesijām

Tulkot transkripciju

Tulkot transkripcijas tekstu citā valodā

Transcribe Audio no URL

Transkribēt runu no iepriekš ierakstīta audio URL vienkāršā tekstā

Transkripcijas pieprasījums un atbilde

Vispārējās pieprasījumu opcijas un atbildes visām transkripcijas darbībām

Pārrakstīt un prezentēt Polyglot sesiju

Izveidojiet sesiju, kuru var izmantot, lai pārraidītu tiešraides transkripciju, izmantojot publiski kopīgojamu saiti

Klienta puses autentifikācijas žetoni

Pārlūkot dokumentāciju
Izveidot pagaidu autentifikācijas žetonu klienta puses pieprasījumiem. Droši ieviesiet API pieprasījumus tīmekļa pārlūkprogrammās, nepakļaujot savas API atslēgas.
Autentifikācijas žetoni ir būtisks drošības pasākums klientu vidē, kur jums ir nepieciešami VocalStack API pakalpojumi. Tas būs nepieciešams, ieviešot API pieprasījumus tīmekļa pārlūkprogrammās, lietotnēs vai citās publiskās vidēs.
Servera pusē mēs varam izmantot SDK, lai ģenerētu autentifikācijas žetonu. Pēc noklusējuma, opcijas par žetonu ir ierobežojoši. Jūs varat vēlēties atjaunināt šos, lai atbilstu jūsu prasībām:
  • access: Vai nu "tikai lasīšanai" vai "lasītrakstīšanai". Pirmais ļauj jums izpildīt API izsaukumus, kas atgriež datus. Pēdējais ļauj jums arī izpildīt API pieprasījumus, kas ietver ar rēķinu saistītas transkripcijas darbības. Šīs opcijas noklusējuma vērtība ir. "tikai lasīšanai".
  • lifetime_s: Skaitlis no 1 līdz 120, kas norāda žetona darbības laiku sekundēs. Pēc šī perioda beigām žetona derīguma termiņš beigsies un tas vairs nebūs izmantojams. Ņemiet vērā, ka tas neietekmēs asinhronos pieprasījumus, kas jau ir sākuši izmantot šo žetonu. (Citiem vārdiem sakot, kad asinhronais pieprasījums ir sākts, tas tiks izpildīts līdz beigām, pat ja pēc pieprasījuma sākšanas ir beidzies pilnvarojuma termiņš. ) Šīs opcijas noklusējuma vērtība ir. 10 mg.
  • one_time: Būlisks skaitlis, kas norāda, vai šis API žetons ir paredzēts vienreizējai lietošanai. Ja true, tad pēc tam, kad šis žetons ir izmantots API pieprasījumam, tā derīguma termiņš beigsies. Šīs opcijas noklusējuma vērtība ir. patiess.
Lūk, kā tas izskatīsies jūsu 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.
Jums būs nepieciešams iestatīt mehānismu, lai apkalpotu jūsu servera ģenerētu API žetonu jūsu klientam. Tas lielā mērā būs atkarīgs no jūsu infrastruktūras un tehnoloģiju krājuma. Pārliecinieties, ka jūs īstenojat drošības labāko praksi. Piemēram, nevajadzētu izveidot API galapunktu, kas neautentificētiem pieprasījumiem apkalpo ģenerētus API žetonus.
VocalStack API patēriņš klienta pusē prasa, lai jūs izmantotu. authToken iestatīšana vietā apiKey.Piemēram, apsveriet Transcribe Audio no URL dokumentāciju.
Šajā piemērā vienkārši aizstāt:
{ apiKey: 'YOUR-API-KEY' } ar { authToken: 'YOUR-AUTH-TOKEN' } 👇
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();
Ģenerējot un apkalpojot klienta puses autentifikācijas žetonus, ir svarīgi ieviest stingrus drošības pasākumus, lai novērstu neatļautu piekļuvi jūsu API. Žetoni ir spēcīgi rīki piekļuvei resursiem un pakalpojumiem, un, ja tie nav aizsargāti, tos var izmantot ļaunprātīgi. Jums ir jānodrošina, ka tikai pilnvaroti klienti var pieprasīt un izmantot žetonus, un jūs nekad nedrīkstat atklāt sensitīvus datus, piemēram, API atslēgas publiskā vidē. Ja tas netiks darīts, var rasties datu pārkāpumi, nesankcionēta piekļuve resursiem vai nejaušas maksas par pakalpojumiem, par kuriem jāmaksā.
Lai palīdzētu aizsargāt ieviešanu, apsveriet tālāk minēto paraugpraksi.:
  • Nekad nepakļaujiet savas API atslēgas klienta pusē: API atslēgas vienmēr jāsaglabā konfidenciālas un droši jāuzglabā serverī. Pakļaujot tos klienta puses kodā (t.i. g JavaScript, HTML) var novest pie nesankcionētas piekļuves API.
  • Izmantojiet drošu servera puses žetonu ģenerēšanu: Vienmēr ģenerēt autentifikācijas žetonus servera pusē, lai novērstu API atslēgu atklāšanu klienta kodā.
  • Autentificēt pieprasījumus pēc žetoniem: Nodrošiniet, lai tikai autentificēti lietotāji vai pakalpojumi varētu pieprasīt API žetonu, piemērojot autentifikācijas mehānismus (piem. g. , OAuth, sesijas validācija).
  • Ieviest HTTPS: Vienmēr apkalpot žetonus, izmantojot HTTPS, lai aizsargātu pret cilvēka-vidū uzbrukumiem.
  • Izvairieties no pierādījumu ievietošanas vietrāžos URL: URL vaicājuma parametros nekad nenododiet pilnvaras, jo tās var tikt reģistrētas servera žurnālos vai atklātas pārlūkprogrammas vēsturē.
  • Ierobežot žetonu darbības jomu: Ierobežojiet žetonus līdz minimālajām nepieciešamajām atļaujām, piemēram, tikai lasīšanas piekļuvei, ja vien nav skaidri nepieciešama rakstīšanas piekļuve.
  • Uzstādīt žetonu derīguma termiņu: Izmantojiet īsus žetonu dzīves ciklus, lai samazinātu žetonu ļaunprātīgas izmantošanas risku. Apsveriet iespēju ierobežot pilnvaru darbības laiku, pamatojoties uz lietošanas modeļiem un drošības vajadzībām.
  • Iespējot vienreizējās lietošanas žetonus: Ja iespējams, izmantojiet vienreizējus žetonus īpaši sensitīvām darbībām, lai nodrošinātu, ka tos nevar izmantot atkārtoti.
Scroll Up