VocalStack Logo

Documentation

Gauti transkribavimo duomenis

Gauti duomenis iš laukiančių arba baigtų transkripcijų

Transkribavimas iš mikrofono arba LiveStream

Transkripuoti gyvą kalbą iš mikrofono ar tiesioginio srauto

Transkripcijos seansai

Stebėti ir valdyti transkripcijos būseną su seansais

Išversti transkribą

Verskite transkribuotą tekstą į kitą kalbą

Transkribuoti garso iš URL

Transkripuoti kalbą iš iš anksto įrašyto garso URL į paprastą tekstą

Transkribavimo užklausa ir atsakymas

Bendrosios visų transkripcijos operacijų užklausos parinktys ir atsakymai

Transkribuoti ir pristatyti poliglotą sesiją

Sukurti sesiją, kuri gali būti naudojama transliuoti tiesioginę transkripciją per viešą bendrinimo nuorodą

Kliento pusės autentifikavimo žetonai

Naršyti dokumentaciją
Sukurti laikiną autentifikavimo ženklą kliento pusės užklausoms. Saugiai įdiekite API užklausas žiniatinklio naršyklėse, neatskleidžiant savo API raktų.
Autentifikacijos žetonai yra esminė saugumo priemonė klientų aplinkose, kur reikia VocalStack API paslaugų. Tai reikės, kai įgyvendinsite API užklausas žiniatinklio naršyklėse, programose ar bet kokioje kitoje viešoje aplinkoje.
Serverio pusėje galime naudoti SDK, kad sugeneruotume autentifikavimo žetoną. Pagal numatytuosius nustatymus, ženklo parinktys yra ribojančios. Galite atnaujinti šiuos, kad atitiktų jūsų reikalavimus:
  • access: Arba "tik skaityti" arba "skaityti rašyti". Pirmasis leidžia jums vykdyti API iškvietimus, kurie grąžina duomenis. Pastaroji taip pat leidžia vykdyti API užklausas, kurios apima su apmokestinamu transkripvimu susijusias operacijas. Numatytoji šios parinkties reikšmė yra. "skaityti tik".
  • lifetime_s: Skaičius nuo 1 iki 120, nurodantis žetono gyvavimo laiką sekundėmis. Po šio laikotarpio žetonas nustos galioti ir nebebus naudojamas. Atkreipkite dėmesį, kad tai neturės įtakos asinchroniniams prašymams, kurie jau pradėti naudoti šį ženklą. (Kitaip tariant, kai asinchroninė užklausa buvo pradėta, ji bus vykdoma iki galo, net jei rakto galiojimas baigėsi po to, kai užklausa buvo pradėta. ) Numatytoji šios parinkties reikšmė yra. 10.
  • one_time: Būlio reikšmė, nurodanti, ar šis API ženklas skirtas vienkartiniui naudojimui. Jei šis raktas buvo naudojamas API užklausai, jo galiojimo laikas baigsis. Numatytoji šios parinkties reikšmė yra. tiesa.
Štai kaip tai atrodys jūsų serveryje:
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 reikės nustatyti mechanizmą, kuris jūsų serverio sugeneruotą API žetoną pateiktų jūsų klientui. Tai didžiąja dalimi priklausys nuo jūsų infrastruktūros ir technologijų. Įsitikinkite, kad įgyvendinate geriausią saugumo praktiką. Pavyzdžiui, neturėtumėte kurti API pabaigos taško, kuris teikia sugeneruotus API prieigos raktus neautentifikuotoms užklausoms.
VocalStack API naudojimas kliento pusėje reikalauja, kad naudotumėte. authToken setting vietoj an apiKey. Pavyzdžiui, apsvarstykite Transkribuoti garso iš URL dokumentaciją.
Šiame pavyzdyje tiesiog pakeiskite:
{ apiKey: 'YOUR-API-KEY' } su { 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();
Generuojant ir teikiant kliento autentifikavimo žetonus, labai svarbu įgyvendinti griežtas saugumo priemones, kad būtų išvengta neteisėtos prieigos prie jūsų API. Tokenai yra galingi įrankiai, leidžiantys pasiekti išteklius ir paslaugas, ir jei jie neapsaugoti, jais galima piktnaudžiauti. Turite užtikrinti, kad tik įgalioti klientai galėtų prašyti ir naudoti raktus, ir niekada neturėtumėte atskleisti slaptų duomenų, tokių kaip API raktai, viešoje aplinkoje. Jei to nepadarysite, gali būti pažeisti duomenys, neteisėtai pasiekti ištekliai arba netyčia sumokėti mokesčiai už mokamas paslaugas.
Kad apsaugotumėte savo įdiegimą, apsvarstykite šiuos geriausios praktikos pavyzdžius:
  • Niekada neatskleisk savo API raktų kliento pusėje: API raktai visada turi būti konfidencialūs ir saugiai saugomi serveryje. Atskleisti juos kliento pusėje kodą (e. g. JavaScript, HTML) gali sukelti neteisėtą prieigą prie API.
  • Naudokite saugų serverio pusės žetonų generavimą: Visada generuoti autentifikavimo žetonus serverio pusėje, kad būtų išvengta API raktų atskleidimo kliento kode.
  • Autentifikuoti žetonų užklausas: Užtikrinkite, kad tik autentifikuoti vartotojai ar paslaugos galėtų prašyti API rakto, įgyvendindami autentifikavimo mechanizmus (pvz. g. , OAuth, sesijos patvirtinimas).
  • Įgyvendinti HTTPS: Visada teikti žetonus per HTTPS, kad apsaugotų nuo tarpininko atakų.
  • Venkite rodyti prieigos raktus URL: Niekada neduokite URL užklausos parametrų, nes jie gali būti įrašyti į serverio žurnalus arba atskleisti naršyklės istorijoje.
  • Apriboti žetonų taikymo sritį: Apriboti žetonus iki minimalaus reikiamo leidimo, pavyzdžiui, tik skaitymo prieiga, nebent aiškiai reikalaujama rašymo prieiga.
  • Nustatyti žetonų galiojimo pabaigos datą: Naudokite trumpą žetonų gyvavimo laiką, kad sumažintumėte netinkamo žetonų naudojimo riziką. Apsvarstykite galimybę apriboti prieigos raktų gyvavimo trukmę, atsižvelgiant į naudojimo modelius ir saugos poreikius.
  • Įgalinti vienkartinio naudojimo žetonus: Jei įmanoma, ypač jautriems veiksmams naudokite vienkartinius žetonus, kad užtikrintumėte, jog jų nebus galima pakartotinai naudoti.
Scroll Up