VocalStack Logo

Documentation

Hanki transkriptiotietoja

Hae tietoja odotettavissa olevista tai valmiista transkriptioista

Puhtaaksi kirjoittaminen mikrofonista tai LiveStream-palvelusta

Puhtaaksi kirjoita live-puhe mikrofonista tai live-suoratoisto

Transkriptio-istunnot

Valvo ja hallitse transkriptiotilan istuntoja

Käännä transkriptio

Käännä transkriptoitu teksti toiselle kielelle

Puhtaaksi kirjoittaa ääntä URL-osoitteesta

Puheen transkriptio URL-osoitteessa olevasta valmiiksi tallennetusta äänestä pelkäksi tekstiksi

Transkriptiopyyntö ja vastaus

Kaikkien transkriptio-operaatioiden yhteiset pyyntöasetukset ja vastaukset

Polyglot-istunnon transkriptio ja esittely

Luo istunto, jota voidaan käyttää lähettämään live-puhekirjotusta julkisesti jaettavan linkin kautta

Asiakaspuolen todennusmerkit

Selaa dokumentaatiota
Luo väliaikainen todennustunnus asiakaspuolen pyyntöjä varten. Toteuta API-pyynnöt turvallisesti verkkoselaimissa ilman, että API-avaimet paljastuvat.
Todennusmerkit ovat olennainen turvatoimenpide asiakasympäristöissä, joissa tarvitaan VocalStack API -palveluita. Tätä tarvitaan, kun API-pyyntöjä toteutetaan verkkoselaimissa, sovelluksissa tai muissa julkisissa ympäristöissä.
Palvelinpuolella voimme käyttää SDK:ta luomaan todennusmerkinnän. Oletusarvoisesti tunnuksen asetukset ovat rajoittavia. Voit halutessasi päivittää nämä vaatimuksiisi sopiviksi:
  • access: Joko "vain luku" tai "kirjoitus". Ensin mainitun avulla voit suorittaa API-kutsuja, jotka palauttavat tietoja. Jälkimmäinen mahdollistaa myös API-pyyntöjen suorittamisen, joka sisältää laskutukseen liittyviä transkriptio-operaatioita. Tämän asetuksen oletusarvo on. "vain luku".
  • lifetime_s: Numero 1:n ja 120:n välillä, joka edustaa tunnuksen elinikää sekunteina. Tämän ajan kuluttua tunnus vanhenee eikä sitä voi enää käyttää. Huomaa, että tämä ei vaikuta asynkronisiin pyyntöihin, jotka ovat jo aloittaneet tämän tunnuksen käytön. (Toisin sanoen kun asynkroninen pyyntö on käynnistetty, se suoritetaan loppuun asti, vaikka tunnus olisi vanhentunut pyynnön käynnistämisen jälkeen. ) Tämän asetuksen oletusarvo on. 10 10.
  • one_time: Boolen arvo, joka ilmaisee onko tämä API-tunnus tarkoitettu kertakäyttöön. Jos true, kun tätä tunnusta on käytetty API-pyyntöön, se vanhenee. Tämän asetuksen oletusarvo on. tosi.
Tältä tämä näyttää palvelimellasi:
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.
Sinun täytyy asettaa mekanismi, jolla palvelimesi luoma API-tunnus tarjotaan asiakkaalle. Tämä riippuu suurelta osin infrastruktuurista ja teknologiasta. Varmista, että otat käyttöön parhaat turvallisuuskäytännöt. Sinun ei esimerkiksi pitäisi luoda API-päätepistettä, joka palvelee luotuja API-tunnuksia todentamattomissa pyynnöissä.
VocalStack API:n käyttäminen asiakkaan puolella edellyttää, että käytät. authToken asetus sijasta apiKey. Tarkastele esimerkiksi seuraavan ohjeita: Puhtaaksi kirjoittaa ääntä URL-osoitteesta.
Tässä esimerkissä korvataan:
{ apiKey: 'YOUR-API-KEY' } with { authToken: 'YOUR-AUTH-TOKEN' } 6. Suom.
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();
Kun luot ja tarjoat asiakaspuolen todennusmerkkejä, on tärkeää ottaa käyttöön tiukat turvatoimet, jotta estetään luvaton pääsy API:isi. Tunnukset ovat tehokkaita työkaluja resurssien ja palveluiden käytössä, ja jos niitä ei suojata, niitä voidaan käyttää väärin. Sinun on varmistettava, että vain valtuutetut asiakkaat voivat pyytää ja käyttää tunnuksia, eikä sinun pitäisi koskaan paljastaa arkaluonteisia tietoja, kuten API-avaimia, julkisessa ympäristössä. Jos näin ei tehdä, seurauksena voi olla tietomurto, luvaton pääsy resursseihin tai tahattomia laskutusmaksuja laskutettavista palveluista.
Voit suojata käyttöönoton ottamalla huomioon seuraavat parhaat käytännöt:
  • Älä koskaan paljasta API-avaimia asiakkaan puolella: API-avainten tulee aina pysyä luottamuksellisina ja ne tulee säilyttää turvallisesti palvelimella. Niiden paljastaminen asiakaspuolen koodissa (e. g. JavaScript, HTML) voi johtaa API:n luvattomaan käyttöön.
  • Käytä suojattua palvelinpuolen tunnuksen luomista: Luo aina palvelinpuolen todennusmerkkejä, jotta API-avaimet eivät pääse näkymään asiakaskoossa.
  • Tunnusmerkkien todennuspyynnöt: Varmista, että vain todennetut käyttäjät tai palvelut voivat pyytää API-tunnusta pakottamalla todennusmekanismit (e. g. , OAuth, istunnon vahvistus).
  • Ota HTTPS käyttöön: Palvele aina tunnuksia HTTPS:n kautta suojataksesi man-in-the-middle -hyökkäyksiltä.
  • Vältä tunnisteiden paljastumista URL-osoitteissa: Älä koskaan anna tunnuksia URL-kyselyparametreissa, koska ne saatetaan kirjata palvelimen lokeihin tai paljastaa selaimen historiassa.
  • Rajoita tunnuksen soveltamisalaa: Rajoita tunnusten käyttöoikeudet minimiin, kuten vain lukuoikeudet, ellei kirjoitusoikeutta ole nimenomaisesti vaadittu.
  • Aseta tunnuksen vanheneminen: Käytä lyhyitä tunnusten elinkaariaikoja vähentääksesi tunnusten väärinkäytön riskiä. Harkitse tunnusten elinkaaren rajoittamista käyttötapojen ja tietoturvatarpeiden perusteella.
  • Ota käyttöön kertakäyttöiset tunnukset: Jos mahdollista, käytä kertakäyttöisiä tunnuksia erityisen arkaluonteisiin toimintoihin, jotta niitä ei voida käyttää uudelleen.
Scroll Up