VocalStack Logo

Documentation

Transcriptiegegevens ophalen

Haal gegevens op van lopende of voltooide transcripties

Transcriberen van een microfoon of LiveStream

Transcribeer live spraak van een microfoon of live stream

Transcriptiesessies voor studenten

Bewaak en beheer de transcriptiestatus met sessies

Een transcriptie vertalen

Vertaal getranscribeerde tekst naar een andere taal

Audio van URL transcriberen

Transcribeer spraak van vooraf opgenomen audio in een URL naar platte tekst

Transcriptieaanvraag en antwoord

Gebruik de opties om de transcriptie-instellingen te configureren en de transcriptie-instellingen te wijzigen

Een Polyglot-sessie transcriberen en presenteren

Maak een sessie die kan worden gebruikt om een live transcriptie uit te zenden via een openbare link die kan worden gedeeld

Tokens voor client-side-verificatie

Blader door de documentatie
Maak een tijdelijk authenticatie token voor client-side verzoeken. Implementeer API-verzoeken veilig in webbrowsers zonder uw API-sleutels bloot te stellen.
Authenticatie tokens zijn een essentiële beveiligingsmaatregel in client omgevingen waar u VocalStack API diensten nodig heeft. U hebt dit nodig bij het implementeren van API-verzoeken in webbrowsers, apps of andere openbare omgevingen.
Aan de server kant kunnen we de SDK gebruiken om een auth token te genereren. Standaard zijn de opties voor het token beperkend. U kunt deze bijwerken om aan uw eisen te voldoen:
  • access: Ofwel "alleen-lezen" ofwel "lezen-schrijven". Met de eerste kunt u API-oproepen uitvoeren die gegevens retourneren. Met de laatste kunt u ook API-verzoeken uitvoeren die factureerbare transcriptiegerelateerde bewerkingen bevatten. De standaardwaarde voor deze optie is. "alleen lezen".
  • lifetime_s: Een getal tussen 1 en 120 dat de levensduur van het token in seconden aangeeft. Na deze periode verloopt het token en is het niet meer bruikbaar. Merk op dat dit geen invloed heeft op asynchrone verzoeken die al zijn gestart met behulp van dit token. (Met andere woorden, zodra een asynchrone aanvraag is gestart, wordt deze uitgevoerd totdat deze is voltooid, zelfs als het token is verlopen nadat de aanvraag is gestart. ) De standaardwaarde voor deze optie is. 10.
  • one_time: Een boolean die aangeeft of dit API-token bedoeld is voor eenmalig gebruik. Als true, zal dit token verlopen zodra het is gebruikt voor een API-verzoek. De standaardwaarde voor deze optie is. waar.
Dit is hoe dit eruit zal zien op je 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.
Je moet een mechanisme instellen voor het leveren van het door je server gegenereerde API token aan je client. Dit zal grotendeels afhangen van uw infrastructuur en tech stack. Zorg ervoor dat u de beste beveiligingspraktijken implementeert. U moet bijvoorbeeld geen API-eindpunt maken dat gegenereerde API-tokens levert aan niet-geverifieerde aanvragen.
Voor het gebruik van de VocalStack API aan de clientzijde moet u een. authToken instellen in plaats van een apiKey.Neem bijvoorbeeld de documentatie voor Audio van URL transcriberen.
In dit voorbeeld vervang je gewoon:
{ apiKey: 'YOUR-API-KEY' } met { authToken: 'YOUR-AUTH-TOKEN' } 6. uitg.
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();
Bij het genereren en leveren van client-side authenticatie tokens is het van cruciaal belang om strikte beveiligingsmaatregelen te implementeren om ongeautoriseerde toegang tot uw API te voorkomen. Tokens zijn krachtige hulpmiddelen voor toegang tot middelen en diensten, en als ze niet worden beschermd kunnen ze worden misbruikt. U moet ervoor zorgen dat alleen geautoriseerde clients tokens kunnen aanvragen en gebruiken, en u mag nooit gevoelige gegevens zoals API-sleutels in een openbare omgeving openbaar maken. Als u dit niet doet, kan dit leiden tot datalekken, ongeoorloofde toegang tot bronnen of onbedoelde kosten voor factureerbare services.
Om uw implementatie te beveiligen, kunt u de volgende aanbevolen procedures overwegen:
  • Stel uw API-sleutels nooit bloot aan de clientzijde: API-sleutels moeten altijd vertrouwelijk blijven en veilig worden opgeslagen op de server. Ze blootstellen in client-side code (e.g. g. JavaScript, HTML) kan leiden tot ongeoorloofde toegang tot de API.
  • Gebruik Secure Server-Side Token Generation: Genereer altijd authenticatietokens aan de serverzijde om blootstelling van API-sleutels in clientcode te voorkomen.
  • Verzoeken voor tokens verifiëren: Zorg ervoor dat alleen geverifieerde gebruikers of services een API-token kunnen aanvragen door authenticatiemechanismen af te dwingen (bijv. g. , OAuth, sessievalidatie).
  • Implementeer HTTPS: Altijd tokens via HTTPS serveren om te beschermen tegen man-in-the-middle aanvallen.
  • Vermijd het weergeven van tokens in URL's: Geef nooit tokens door in URL-queryparameters, omdat deze in serverlogboeken of in de browsergeschiedenis kunnen worden geregistreerd.
  • Tokenbereik beperken: Beperk tokens tot het minimum aan noodzakelijke rechten, zoals alleen-lezen toegang, tenzij schrijftoegang expliciet vereist is.
  • Set Token vervaldatum: Gebruik korte tokenlevensduur om het risico van tokenmisbruik te verminderen. Overweeg de levensduur van tokens te beperken op basis van gebruikspatronen en beveiligingsbehoeften.
  • Eenmalige tokens inschakelen: Gebruik indien mogelijk eenmalige tokens voor bijzonder gevoelige acties om ervoor te zorgen dat ze niet opnieuw kunnen worden gebruikt.
Scroll Up