VocalStack Logo

Documentation

Hent transkripsjonsdata

Hent data fra ventende eller fullførte transkripsjoner

Transkribere fra en mikrofon eller LiveStream

Transkriber live tale fra en mikrofon eller live stream

Transkripsjonsøkter

Overvåk og administrer transkripsjonsstatus med økter

Oversett en transkripsjon

Oversett transkribert tekst til et annet språk

Transkriber lyd fra URL

Transkriber tale fra forhåndsinnspilt lyd i en URL til ren tekst

Autentiseringstegn på klientsiden

Forespørsel om transkripsjon og svar

Vanlige forespørselsvalg og svar for alle transkripsjonsoperasjoner

Transkribere og presentere en Polyglot-økt

Opprett en økt som kan brukes til å kringkaste en direktetranskripsjon via en offentlig delbar kobling

Autentiseringstegn på klientsiden

Bla gjennom dokumentasjon
Opprett et midlertidig autentiseringsmerke for forespørsler fra klientsiden. Implementer API-forespørsler trygt i nettlesere uten å avsløre API-nøklene dine.
Autentiseringstokens er et viktig sikkerhetstiltak i klientmiljøer der du trenger VocalStack API-tjenester. Du trenger dette når du implementerer API-forespørsler i nettlesere, apper eller andre offentlige miljøer.

Generere et autentiseringsmerke

På serversiden kan vi bruke SDK for å generere en autentiseringsnøkkel. Som standard er valgene for token restriktive. Du kan oppdatere disse for å passe dine behov:
  • access: Enten « readonly » eller « readwrite ». Førstnevnte gjør det mulig å utføre API-anrop som returnerer data. Sistnevnte gjør det mulig å også utføre API-forespørsler som inkluderer fakturerbare transkripsjonsrelaterte operasjoner. Standardverdien for dette valget er "bare- lesbar".
  • lifetime_s: Et tall mellom 1 og 120 som representerer levetiden til tokenet i sekunder. Etter denne perioden vil tokenet utløpe og vil ikke lenger være brukbart. Merk at dette ikke vil påvirke asynkrone forespørsler som allerede har startet å bruke dette tokenet. (Når en asynkron forespørsel har startet, kjører den med andre ord til fullføring selv om tokenet har utløpt etter at forespørselen har startet. ) Standardverdien for dette alternativet er. 10.
  • one_time: En boolsk verdi som angir om dette API- tokenet er ment for engangsbruk. Hvis sann, vil dette tokenet utløpe når det har blitt brukt for en API-forespørsel. Standardverdien for dette valget er sann.
Her er hvordan dette vil se ut på serveren din:
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.
Du må sette opp en mekanisme for å servere servergenerert API- token til klienten din. Dette vil i stor grad avhenge av infrastrukturen og teknologien din. Sørg for at du implementerer beste praksis for sikkerhet. Du bør for eksempel ikke opprette et API-endepunkt som serverer genererte API-tokens til ikke-godkjente forespørsler.

Bruke et godkjenningstoken

Forbruk av VocalStack API på klientsiden krever at du bruker en. authToken setting i stedet for en apiKey. Se for eksempel på dokumentasjonen for Transkriber lyd fra URL.
I dette eksempelet erstatter du bare:
{ apiKey: 'YOUR-API-KEY' } med { authToken: 'YOUR-AUTH-TOKEN' } 6. utg.
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();

Sikkerhetsoverveielser

Når du genererer og serverer autentiseringstokens på klientsiden, er det viktig å implementere strenge sikkerhetstiltak for å forhindre uautorisert tilgang til API-en. Tokens er kraftige verktøy for å få tilgang til ressurser og tjenester, og hvis de ikke er beskyttet, kan de misbrukes. Du må sørge for at kun autoriserte klienter kan be om og bruke tokens, og du bør aldri avsløre sensitive data som API-nøkler i et offentlig miljø. Hvis du ikke gjør dette, kan det føre til datainnbrudd, uautorisert tilgang til ressurser eller utilsiktede kostnader for fakturerbare tjenester.
Vurder følgende anbefalte fremgangsmåter for å sikre implementeringen:
  • Aldri utsette dine API-nøkler på klientsiden: API-nøkler bør alltid holdes konfidensielle og lagres sikkert på serveren. Å eksponere dem i klientsiden kode (e. g JavaScript, HTML) kan føre til uautorisert tilgang til API.
  • Bruk sikker tokengenerering på serversiden: Generer alltid autentiseringstokens på serversiden for å forhindre eksponering av API-nøkler i klientkode.
  • Godkjenn forespørsler om tokens: Sørg for at bare autentiserte brukere eller tjenester kan be om et API-token ved å håndheve autentiseringsmekanismer (f.eks. Mr. , OAuth, øktvalidering).
  • Implementer HTTPS: Alltid tjene tokens over HTTPS for å beskytte mot man-in-the-middle angrep.
  • Unngå å vise tokens i nettadresser: Aldri overføre tokens i URL-spørringsparametre som de kan bli logget i serverlogger eller eksponert i nettleserhistorikk.
  • Begrens token- omfang: Begrense tokens til det minste nødvendige tillatelser, for eksempel skrivebeskyttet tilgang med mindre skrivetilgang er eksplisitt nødvendig.
  • Sett utløpsdato for token: Bruk korte levetider for token for å redusere risikoen for token misbruk. Vurder å begrense levetiden til tokens basert på bruksmønstre og sikkerhetsbehov.
  • Slå på engangstokens: Hvis mulig, bruk engangs-tokens for spesielt sensitive handlinger for å sikre at de ikke kan gjenbrukes.
Scroll Up