VocalStack Logo

Documentation

Sækja útskriftargögn

Fá gögn frá bið eða lokið afritunum

Skrifaðu frá hljóðnema eða LiveStream

Afritaðu lifandi ræðu úr hljóðnema eða lifandi straumi

Uppskrift

Fylgjast með og stjórna ritun stöðu með setum

Þýða uppskrift

Þýddu afrituð texta á annað tungumál

Afrita hljóð frá slóð

Umrita ræðu frá fyrirfram upptöku hljóð í vefslóð í venjulegum texta

Auðkennistákn á biðlarahlið

Uppskrift Beiðni og svar

Algengar beiðnir og svör fyrir allar afritunaraðgerðir

Skrifaðu og kynntu fjöltyngdarfund

Búa til setu sem hægt er að nota til að senda út lifandi afritun í gegnum opinberan tengil

Auðkennistákn á biðlarahlið

Skoða handbækur
Búa til tímabundið auðkennistákn fyrir beiðnir frá biðlara. Örugglega framkvæma API beiðnir í vöfrum án þess að afhjúpa API lykla.
Staðfestingartákn eru nauðsynleg öryggisráðstöfun í viðskiptavinaumhverfi þar sem þú þarft VocalStack API þjónustu. Þú þarft þetta þegar þú framkvæmir API beiðnir í vafra, forritum eða öðrum opinberum umhverfi.

Búa til auðkennistákn

Á miðlarahliðinni getum við notað SDK til að búa til auth tákn. Sjálfgefið er að valkostir fyrir táknið séu takmarkaðir. Þú gætir viljað uppfæra þetta til að henta þínum þörfum:
  • access: Annaðhvort "readonly" eða "readwrite". Fyrrverandi gerir þér kleift að framkvæma API símtöl sem skila gögnum. Síðari gerir þér einnig kleift að framkvæma API beiðnir sem innihalda gjaldgengt afritunartengdar aðgerðir. Sjálfgefið gildi fyrir þennan valkost er "aðeins lestur".
  • lifetime_s: Tölu á milli 1 og 120 sem táknar líftíma táknsins í sekúndum. Eftir þetta tímabil rennur táknið út og er ekki lengur notað. Athugið að þetta hefur ekki áhrif á ósamstilltar beiðnir sem þegar hafa byrjað að nota þetta tákn. (Það er að segja, þegar ósamstillt beiðni hefur byrjað, mun það keyra til loka jafnvel þótt táknið hefur runnið út eftir að beiðnin hefur byrjað. ) Sjálfgefið gildi fyrir þennan valkost er. Tíu.
  • one_time: Boolean sem gefur til kynna hvort þetta API tákn sé ætlað til einnota. Ef satt, þegar þetta tákn hefur verið notað fyrir API beiðni, þá rennur það út. Sjálfgefið gildi fyrir þennan valkost er satt.
Hér er hvernig þetta mun líta út á miðlaranum þínum:
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.
Þú þarft að setja upp kerfi til að þjóna API táknið sem miðlarinn þinn býr til við viðskiptavininn þinn. Þetta mun að mestu ráðast á innviði og tækni stafla. Gakktu úr skugga um að þú framkvæmir bestu öryggisvenjur. Til dæmis ættir þú ekki að búa til API endapunkt sem þjónar API táknmyndum sem búnar eru til fyrir ósannvottaðar beiðnir.

Notkun auðkenningartákns

Neyta VocalStack API á viðskiptavinur hlið krefst þess að þú notir. authToken stilling í staðinn fyrir apiKey. Til dæmis, íhuga skjöl fyrir Afrita hljóð frá slóð.
Í þessu dæmi skiptir einfaldlega út:
{ apiKey: 'YOUR-API-KEY' } með { authToken: 'YOUR-AUTH-TOKEN' } 6. útgáfa.
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();

Öryggismál

Þegar búið er að búa til og þjóna sannvottunarmerkjum viðskiptavinarins er mikilvægt að framkvæma strangar öryggisráðstafanir til að koma í veg fyrir óheimilan aðgang að API þínum. Merki eru öflug tæki til að fá aðgang að auðlindum og þjónustu og ef þau eru ekki varin er hægt að misnota þau. Þú verður að tryggja að aðeins heimilaðir viðskiptavinir geti beðið um og notað tákn og þú ættir aldrei að afhjúpa viðkvæm gögn eins og API lykla í opinberu umhverfi. Ef það er ekki gert getur það leitt til gagnabrota, óheimils aðgangs að úrræðum eða óæskilegra gjalda fyrir þjónustu sem þarf að greiða fyrir.
Til að hjálpa til við að tryggja framkvæmd þína skaltu íhuga eftirfarandi bestu starfsvenjur:
  • Aldrei afhjúpa API lykla þína á viðskiptavinahlið: API lyklar ættu alltaf að vera trúnaðarmál og geymd á öruggan hátt á þjóninum. Útsetning þeirra í viðskiptavina-hlið kóða (e. dagur JavaScript, HTML) getur leitt til óheimils aðgangs að API.
  • Notaðu örugga miðlara-hlið Token Generation: Alltaf búa til sannvottunartákn á miðlarahlið til að koma í veg fyrir útsetningu API lykla í viðskiptavina kóða.
  • Auðkenna beiðnir um tákn: Tryggja að aðeins auðkenndir notendur eða þjónusta geti óskað eftir API-tákni með því að framfylgja auðkenningaraðferðum (e. G. , OAuth, session staðfesting).
  • Framkvæma HTTPS: Þjóna alltaf táknum yfir HTTPS til að vernda gegn man-in-the-middle árásum.
  • Forðastu að sýna tákn í vefslóðum: Aldrei má gefa tákn í URL fyrirspurnarbreytur þar sem þau gætu verið skráð í netþjónaskrár eða birt í vafrasögu.
  • Takmarka táknmál: Takmarka tákn til lágmarks nauðsynleg heimildir, svo sem lesa-aðeins aðgang nema skrifa aðgang er sérstaklega krafist.
  • Setja gildistíma tákns: Notaðu stutta tákntíma til að draga úr hættu á misnotkun tákns. Íhuga að takmarka tákn líftíma byggt á notkun mynstur og öryggisþörf.
  • Virkja einnota tákn: Ef mögulegt er, nota einnota tákn fyrir sérstaklega viðkvæmar aðgerðir til að tryggja að þeir geti ekki verið endurnýtt.
Scroll Up