VocalStack Logo

Documentation

Hämta transkriptionsdata

Hämta data från väntande eller slutförda transkriptioner

Transkribera från en mikrofon eller LiveStream

Transkribera live-tal från en mikrofon eller live-stream

Transkriptionssessioner

Övervaka och hantera transkriptionsstatus med sessioner

Översätt en transkription

Översätt transkriberad text till ett annat språk

Transkribera ljud från URL

Transkribera tal från förinspelade ljud i en URL till klartext

Begäran om transkription och svar

Vanliga alternativ för begäran och svar för alla transkriptionsåtgärder Använd alternativ för att konfigurera transkriptionsinställningarna

Transkribera och presentera en Polyglot-session

Skapa en session som kan användas för att sända en live-transkription via en offentlig länk som kan delas

Autentiseringstoken på klientsidan

Bläddra i dokumentationen
Skapa en tillfällig autentiseringstoken för begäranden på klientsidan. Implementera API-förfrågningar på ett säkert sätt i webbläsare utan att exponera dina API-nycklar.
Autentiseringstokens är en viktig säkerhetsåtgärd i klientmiljöer där du behöver VocalStack API-tjänster. Du behöver detta när du implementerar API-förfrågningar i webbläsare, appar eller andra offentliga miljöer.
På serversidan kan vi använda SDK för att generera en auth token. Som standard är alternativen för token restriktiva. Du kanske vill uppdatera dessa för att passa dina behov:
  • access: Antingen "readonly" eller "readwrite". Den förra gör det möjligt att utföra API-anrop som returnerar data. Det senare gör det möjligt att även utföra API-förfrågningar som inkluderar fakturerbara transkriptionsrelaterade operationer. Standardvärdet för detta alternativ är. "endast läsning".
  • lifetime_s: Ett tal mellan 1 och 120 som representerar tokenets livslängd i sekunder. Efter denna period kommer token att upphöra och kommer inte längre att vara användbar. Observera att detta inte påverkar asynkrona förfrågningar som redan har börjat använda denna token. (När en asynkron begäran har startats kommer den med andra ord att köras till slutförande även om token har upphört att gälla efter att begäran har startats. ) Standardvärdet för detta alternativ är. 10.
  • one_time: En boolesk som anger om denna API-token är avsedd för engångsbruk. Om true, när denna token har använts för en API-begäran, kommer den att upphöra. Standardvärdet för detta alternativ är. sant.
Så här kommer det att se ut 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 måste konfigurera en mekanism för att servera din servergenererade API-token till din klient. Detta beror till stor del på din infrastruktur och tekniska stack. Se till att du implementerar bästa säkerhetspraxis. Du bör till exempel inte skapa en API-slutpunkt som visar genererade API-token för oautentiserade begäranden.
För att använda VocalStack API på klientsidan krävs att du använder en. authToken inställning istället för en apiKey. Till exempel, överväg dokumentationen för Transkribera ljud från URL.
I det här exemplet ersätter du helt enkelt:
{ apiKey: 'YOUR-API-KEY' } med { authToken: 'YOUR-AUTH-TOKEN' } 6. uppl.
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 genererar och tillhandahåller autentiseringstoken på klientsidan är det viktigt att implementera strikta säkerhetsåtgärder för att förhindra obehörig åtkomst till ditt API. Tokens är kraftfulla verktyg för att få tillgång till resurser och tjänster, och om de inte skyddas kan de missbrukas. Du måste se till att endast auktoriserade klienter kan begära och använda tokens, och du bör aldrig exponera känsliga data som API-nycklar i en offentlig miljö. Om du inte gör det kan det leda till dataintrång, obehörig åtkomst till resurser eller oavsiktliga avgifter för fakturerbara tjänster.
För att säkra din implementering bör du överväga följande bästa metoder:
  • Exponera aldrig dina API-nycklar på klientsidan: API-nycklar ska alltid förbli konfidentiella och lagras säkert på servern. Exponera dem i klientsidan kod (e. g. JavaScript, HTML) kan leda till obehörig åtkomst till API.
  • Använd säker tokengenerering på serversidan: Generera alltid autentiseringstoken på serversidan för att förhindra exponering av API-nycklar i klientkod.
  • Autentisera begäranden om tokens: Se till att endast autentiserade användare eller tjänster kan begära en API-token genom att tillämpa autentiseringsmekanismer (t.ex. g. , OAuth, sessionsvalidering).
  • Implementera HTTPS: Servera alltid tokens över HTTPS för att skydda mot man-in-the-middle-attacker.
  • Undvik att visa tokens i webbadresser: Skicka aldrig tokens i URL-frågeparametrar eftersom de kan loggas i serverloggar eller exponeras i webbläsarens historik.
  • Begränsa token-omfattning: Begränsa tokens till det minsta nödvändiga behörigheter, såsom read-only åtkomst om inte skrivåtkomst krävs uttryckligen.
  • Ställ in token-utgång: Använd korta livslängder för tokens för att minska risken för missbruk. Överväg att begränsa tokens livslängd baserat på användningsmönster och säkerhetsbehov.
  • Aktivera engångstoken: Om möjligt, använd engångstoken för särskilt känsliga åtgärder för att säkerställa att de inte kan återanvändas.
Scroll Up