Documentation

Nôl Data Trawssgrifiad

Nôl data o drosysgrifiadau ar y gweill neu wedi'u cwblhau

Trosysgrifo o'r Meicroffon neu LiveStream

Trosysgrifo siarad byw o microffon neu llif byw

Sesiynau Trawssgrifiad

Monitro a rheoli cyflwr trosglwyddo gyda sesiynau

Cyfieithu

Cyfieithu testun wedi' i drosi i iaith arall

Trosysgrifo Sain o URL

Trosysgrifo iaith o sain wedi'i recordio'n barod mewn URL i destun plaen

Cais a Ymateb Trawssgrifiad

Dewisiadau cyffredin cais a chwynion am bob gweithrediad trosglwyddo

Trosysgrifo a Chyflwyno Sesiwn PolyglotName

Creu sesiwn y gellir ei ddefnyddio i ddarlledu trosglwyddiad byw drwy gyswllt cyhoeddus rhannadwy

Tocynnau Dilysiant Ochr y Cleient

Pori Dogfennaeth
Creu tocyn dilysiant dros dro ar gyfer ceisiadau ochr y cleient. Gweithredu ceisiadau API yn ddiogel mewn porwyr gwe heb arddangos eich allweddi API.
Mae tocynnau dilysiant yn fesur diogelwch hanfodol mewn amgylcheddau cleient lle mae angen gwasanaethau API VocalStack arnoch. Bydd angen hyn arnoch pan fyddwch yn gweithredu ceisiadau API mewn porwyr gwe, cymwysiadau neu unrhyw amgylcheddau cyhoeddus eraill.
Ar ochr y gweinydd gallwn ddefnyddio'r SDK i greu tocyn awdurdodi. Yn rhagosodedig, mae'r dewisiadau ar gyfer y tocyn yn gyfyngedig. Efallai hoffech chi ddiweddaru' r canlynol i weddu i' ch anghenion:
  • access: naill ai "darllen-yn-unig" neu "darllen-ysgrifennu". Mae'r cyntaf yn galluogi chi i weithredu galwadau API sy'n dychwelyd data. Mae'r olaf yn galluogi chi i weithredu ceisiadau API hefyd sy'n cynnwys gweithrediadau sy'n gysylltiedig â throsglwyddo biliau. Y gwerth rhagosodedig ar gyfer yr opsiwn hwn yw. "darllen- yn- unig".
  • lifetime_s: Rhif rhwng 1 a 120 yn cynrychioli oes y tocyn mewn eiliadau. Ar ôl y cyfnod hwn, bydd y tocyn yn darfod ac ni fydd yn ddefnyddiol mwyach. Noder na fydd hyn yn effeithio ar geisiadau an- gywasgedig sydd wedi dechrau defnyddio' r tocyn yma eisoes. (Yn eiriau eraill, unwaith mae cais an- gytbwys wedi dechrau, bydd yn rhedeg hyd at gwblhau hyd yn oed os mae' r tocyn wedi darfod ar ôl i' r cais ddechrau. ) Y gwerth rhagosodedig ar gyfer yr opsiwn hwn yw. 10ed.
  • one_time: Booleaidd yn dangos a yw'r tocyn API hwn wedi ei gynllunio ar gyfer defnydd sengl. Os yn wir, unwaith y defnyddir y tocyn hwn ar gyfer cais API, bydd yn darfod. Y gwerth rhagosodedig ar gyfer yr opsiwn hwn yw. gwir.
Dyma sut y bydd yn edrych ar eich gweinydd:
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.
Bydd angen i chi osod mecanwaith i wasanaethu tocyn API a gynhyrchwyd gan eich gweinydd i'ch cleient. Bydd hyn yn dibynnu'n fawr ar eich strwythur a'ch pentwr technoleg. Gwnewch yn siŵr eich bod yn gweithredu arferion gorau diogelwch. Er enghraifft, ni ddylech greu diwedd-bwynt API sy'n gwasanaethu tocynnau API a gynhyrchir i geisiadau heb eu dilysu.
Mae defnyddio'r API VocalStack ar ochr y cleient yn gofyn i chi ddefnyddio authToken gosod yn lle apiKey. Er enghraifft, ystyried y ddogfennaeth ar gyfer Trosysgrifo Sain o URL.
Yn yr enghraifft hon, dim ond amnewid:
{ apiKey: 'YOUR-API-KEY' } gyda { 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();
Pan yn creu a gwasanaethu tocynnau dilysiant ochr y cleient, mae'n hanfodol i chi weithredu mesurau diogelwch llym i atal mynediad di-drwydded i'ch API. Mae tocynnau yn offer pwerus ar gyfer cyrchu adnoddau a gwasanaethau, a os nad ydynt yn cael eu diogelu, gellir eu camddefnyddio. Rhaid i chi sicrhau mai dim ond cleientiaid awdurdodedig all ofyn a defnyddio tocynnau, a dylech byth arddangos data sensitif fel allweddi API mewn amgylchedd cyhoeddus. Gall methu gwneud hynny arwain at dorri data, cyrchiad di-awdurdodedig at adnoddau, neu ffioedd annisgwyl am wasanaethau biliauadwy.
I helpu i ddiogelu eich gweithredu, ystyried y gweithdrefnau gorau canlynol:
  • Peidio byth â datgelu eich allweddi API ar ochr y cleient: Dylai allweddi API fod yn gyfrinachol o hyd ac yn cael eu cadw'n ddiogel ar y gweinydd. Dangos nhw mewn cod ochr-client (e. g Gall ychwanegu ffeiliau (JavaScript, HTML) arwain at fynediad dilys i'r API.
  • Defnyddio creu tocyn diogel ar ochr y gweinydd: Creu tocynnau dilysiant o hyd ar ochr y gweinydd i atal datgelu allweddi API yn y cod cleient.
  • Dilysu Cais am Tocynnau: Sicrhau mai dim ond defnyddwyr neu wasanaethau dilysedig all ofyn am tocyn API drwy orfodi mecanweithiau dilysu (e. g , OAuth, dilysiant sesiwn).
  • Gweithredoli HTTPS: Defnyddio tocynnau dros HTTPS o hyd i amddiffyn yn erbyn ymosodwyr man-in-the-middle.
  • Peidio â dangos tocynnau mewn URLau: Peidio byth â throsglwyddo tocynnau mewn paramedrau ymholiad URL gan y gallai fod wedi eu cofnodi mewn cofnodion gweinydd neu eu datgelu yn hanes y porwr.
  • Cyfyngiad Tocyn: Terfynu tocynnau i'r caniatadau lleiaf angenrheidiol, fel mynediad darllen-yn-unig oni bai bod angen mynediad ysgrifennu'n glir.
  • Gosod Terfyn Amser Tocyn: Defnyddio bywydau tocyn byr i leihau' r risg o gamddefnyddio tocynnau. Canolbwyntio ar gyfyngu bywydau tocynnau yn seiliedig ar batrymau defnydd a gofynion diogelwch.
  • Galluogi Tocynnau Defnydd Unwaith: Os yn bosibl, defnyddiwch tocynnau untro ar gyfer gweithredoedd sensitif yn arbennig i sicrhau na ellir eu hailddefnyddio.
Scroll Up