VocalStack Logo

Documentation

Hent transskriptionsdata

Hent data fra ventende eller afsluttede transskriptioner

Transskriber fra en mikrofon eller LiveStream

Transskriber live tale fra en mikrofon eller live stream

Transskriptionssessioner

Overvåg og administrer transskriptionsstatus med sessioner

Oversæt en transskription

Oversæt transskriberet tekst til et andet sprog

Transskriber lyd fra URL

Transskriber tale fra forudindspillet lyd i en URL til almindelig tekst

Anmodning om transskription og svar

Fælles anmodningsindstillinger og svar for alle transskriptionshandlinger Brug indstillinger til at konfigurere transskriptionsindstillingerne

Transskriber og præsenter en Polyglot-session

Opret en session, der kan bruges til at udsende en live-transskription via et offentligt link, der kan deles

Tokens til godkendelse på klientsiden

Gennemse dokumentation
Opret et midlertidigt godkendelsestegn til anmodninger på klientsiden. Implementer API-anmodninger sikkert i webbrowsere uden at afsløre dine API-nøgler.
Godkendelsestokens er en vigtig sikkerhedsforanstaltning i klientmiljøer, hvor du har brug for VocalStack API-tjenester. Du skal bruge dette, når du implementerer API-anmodninger i webbrowsere, apps eller andre offentlige miljøer.
På serversiden kan vi bruge SDK'et til at generere et autentificeringstoken. Som standard er indstillingerne for tokenet restriktive. Du kan opdatere disse til at passe til dine behov:
  • access: Enten "skrivebeskyttet" eller "læs- skriv". Førstnævnte gør det muligt at udføre API-kald, der returnerer data. Sidstnævnte gør det muligt også at udføre API-anmodninger, der omfatter fakturerbare transskriptionsrelaterede operationer. Standardværdien for denne indstilling er. "kun til læsning".
  • lifetime_s: Et tal mellem 1 og 120, der repræsenterer levetiden for tokenet i sekunder. Efter denne periode vil tokenet udløbe og vil ikke længere være brugbart. Bemærk, at dette ikke vil påvirke asynkrone anmodninger, der allerede er startet ved hjælp af dette token. (Når en asynkron anmodning er startet, kører den med andre ord til afslutning, selvom tokenet er udløbet, efter at anmodningen er startet. ) Standardværdien for denne indstilling er. 10.
  • one_time: En boolesk værdi, der angiver, om dette API-token er beregnet til engangsbrug. Hvis sand, vil dette token udløbe, når det er blevet brugt til en API-forespørgsel. Standardværdien for denne indstilling er. sand.
Her er, hvordan dette vil se ud på din server:
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 skal opsætte en mekanisme til at servere dit servergenererede API-token til din klient. Dette vil i høj grad afhænge af din infrastruktur og tech stack. Sørg for at implementere bedste sikkerhedspraksis. Du bør f.eks. ikke oprette et API-slutpunkt, der leverer genererede API-tokens til ikke-godkendte anmodninger.
Forbrug af VocalStack API på klientsiden kræver, at du bruger en. authToken indstilling i stedet for en apiKey. Overvej f.eks. dokumentationen til Transskriber lyd fra URL.
I dette eksempel skal du blot erstatte:
{ apiKey: 'YOUR-API-KEY' } med { 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();
Når du genererer og leverer godkendelsestokens på klientsiden, er det afgørende at implementere strenge sikkerhedsforanstaltninger for at forhindre uautoriseret adgang til din API. Tokens er kraftfulde værktøjer til at få adgang til ressourcer og tjenester, og hvis de ikke er beskyttet, kan de misbruges. Du skal sikre, at kun autoriserede klienter kan anmode om og bruge tokens, og du bør aldrig udsætte følsomme data som API-nøgler i et offentligt miljø. Hvis du ikke gør det, kan det resultere i brud på datasikkerheden, uautoriseret adgang til ressourcer eller utilsigtede opkrævninger for fakturerbare tjenester.
Overvej følgende bedste fremgangsmåder for at sikre din implementering:
  • Udsæt aldrig dine API-nøgler på klientsiden: API-nøgler skal altid forblive fortrolige og opbevares sikkert på serveren. Eksponering af dem i klient-side kode (e. g. JavaScript, HTML) kan føre til uautoriseret adgang til API'et.
  • Brug af Secure Server-side Token Generation: Generer altid godkendelsestokens på serversiden for at forhindre eksponering af API-nøgler i klientkode.
  • Godkend anmodninger om tokens: Sørg for, at kun godkendte brugere eller tjenester kan anmode om et API-token ved at håndhæve godkendelsesmekanismer (f.eks. g. , OAuth, session validering).
  • Implementer HTTPS: Altid servere tokens over HTTPS for at beskytte mod man-in-the-middle angreb.
  • Undgå at vise tokens i webadresser: Send aldrig tokens i URL-forespørgselsparametre, da de kan blive logget i serverlogs eller eksponeret i browserens historik.
  • Begræns token-område: Begræns tokens til det mindste nødvendige antal tilladelser, såsom read-only adgang, medmindre skriveadgang udtrykkeligt kræves.
  • Indstil token udløb: Brug korte token-levetider for at reducere risikoen for token-misbrug. Overvej at begrænse tokens levetid baseret på brugsmønstre og sikkerhedsbehov.
  • Aktivér engangspoletter: Hvis det er muligt, skal du bruge engangs-tokens til særligt følsomme handlinger for at sikre, at de ikke kan genbruges.
Scroll Up