VocalStack Logo

Documentation

Transkriptionsdaten abrufen

Abrufen von Daten aus ausstehenden oder abgeschlossenen Transkriptionen

Transkribieren von einem Mikrofon oder LiveStream

Transkribieren Sie Live-Sprache von einem Mikrofon oder Live-Stream

Transkriptionssitzungen

Überwachen und verwalten Sie den Transkriptionsstatus mit Sitzungen

Übersetzen einer Transkription

Übersetzen Sie transkribierten Text in eine andere Sprache

Audio aus URL transkribieren

Transkribieren Sie Sprache aus voraufgezeichnetem Audio in einer URL in Klartext

Transkriptionsanfrage und Antwort

Gemeinsame Anforderungsoptionen und Antworten für alle Transkriptionsvorgänge

Transkribieren und Präsentieren einer Polyglot-Sitzung

Erstellen Sie eine Sitzung, die verwendet werden kann, um eine Live-Transkription über einen öffentlichen Link zu übertragen

Clientseitige Authentifizierungs-Token

Dokumentation durchsuchen
Erstellen Sie ein temporäres Authentifizierungstoken für clientseitige Anforderungen. Implementieren Sie API-Anforderungen sicher in Webbrowsern, ohne Ihre API-Schlüssel offenzulegen.
Authentifizierungstokens sind eine wesentliche Sicherheitsmaßnahme in Client-Umgebungen, in denen VocalStack API-Dienste erforderlich sind. Sie benötigen diese Funktion, wenn Sie API-Anfragen in Webbrowsern, Apps oder anderen öffentlichen Umgebungen implementieren.
Auf der Serverseite können wir das SDK verwenden, um ein Auth-Token zu generieren. Standardmäßig sind die Optionen für das Token restriktiv. Sie können diese an Ihre Anforderungen anpassen:
  • access: Entweder "readonly" oder "readwrite". Erstere ermöglicht es Ihnen, API-Aufrufe auszuführen, die Daten zurückgeben. Letzteres ermöglicht es Ihnen auch, API-Anforderungen auszuführen, die abrechnungsfähige Transkriptionsoperationen beinhalten. Der Standardwert für diese Option ist. "nur zum Lesen".
  • lifetime_s: Eine Zahl zwischen 1 und 120, die die Lebensdauer des Tokens in Sekunden darstellt. Nach dieser Zeit läuft das Token ab und ist nicht mehr nutzbar. Beachten Sie, dass dies keine Auswirkungen auf asynchrone Anfragen hat, die bereits mit diesem Token gestartet wurden. (Mit anderen Worten: Sobald eine asynchrone Anforderung gestartet wurde, wird sie bis zum Abschluss ausgeführt, auch wenn das Token nach dem Start der Anforderung abgelaufen ist. ) Der Standardwert für diese Option ist. 10.
  • one_time: Ein boolescher Wert, der angibt, ob dieses API-Token für eine einmalige Verwendung gedacht ist. Wenn true, läuft dieses Token ab, sobald es für eine API-Anforderung verwendet wurde. Der Standardwert für diese Option ist. true.
So sieht das auf Ihrem Server aus:
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.
Sie müssen einen Mechanismus einrichten, um das von Ihrem Server generierte API-Token an Ihren Client zu liefern. Dies hängt weitgehend von Ihrer Infrastruktur und Ihrem Technologie-Stack ab. Stellen Sie sicher, dass Sie die besten Sicherheitspraktiken umsetzen. Sie sollten beispielsweise keinen API-Endpunkt erstellen, der generierte API-Token für nicht authentifizierte Anforderungen bereitstellt.
Um die VocalStack API auf der Clientseite zu nutzen, müssen Sie eine. authToken Einstellung anstelle von apiKey. Betrachten Sie zum Beispiel die Dokumentation für Audio aus URL transkribieren.
In diesem Beispiel ersetzen Sie einfach:
{ apiKey: 'YOUR-API-KEY' } with { 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();
Bei der Generierung und Bereitstellung von clientseitigen Authentifizierungstokens ist es wichtig, strenge Sicherheitsmaßnahmen zu implementieren, um unbefugten Zugriff auf Ihre API zu verhindern. Tokens sind leistungsstarke Werkzeuge für den Zugriff auf Ressourcen und Dienstleistungen, und wenn sie nicht geschützt sind, können sie missbraucht werden. Sie müssen sicherstellen, dass nur autorisierte Clients Token anfordern und verwenden können. Sie sollten niemals sensible Daten wie API-Schlüssel in einer öffentlichen Umgebung offenlegen. Andernfalls kann es zu Datenschutzverletzungen, unbefugtem Zugriff auf Ressourcen oder unbeabsichtigten Gebühren für abrechnungsfähige Dienste kommen.
Um Ihre Implementierung zu sichern, sollten Sie die folgenden bewährten Methoden berücksichtigen:
  • Geben Sie Ihre API-Schlüssel niemals auf der Client-Seite frei: API-Schlüssel sollten stets vertraulich behandelt und sicher auf dem Server gespeichert werden. Sie im clientseitigen Code offenzulegen (z. g. JavaScript, HTML) kann zu unberechtigtem Zugriff auf die API führen.
  • Verwenden Sie die sichere serverseitige Tokengenerierung: Generieren Sie immer Authentifizierungstokens auf der Serverseite, um die Offenlegung von API-Schlüsseln im Clientcode zu verhindern.
  • Authentifizieren von Anforderungen nach Token: Stellen Sie sicher, dass nur authentifizierte Benutzer oder Dienste ein API-Token anfordern können, indem Sie Authentifizierungsmechanismen erzwingen (z. g. , OAuth, Sitzungsvalidierung).
  • Implementieren Sie HTTPS: Immer Token über HTTPS ausliefern, um sich vor Man-in-the-Middle-Angriffen zu schützen.
  • Vermeiden Sie die Offenlegung von Tokens in URLs: Übergeben Sie niemals Tokens in URL-Abfrageparametern, da diese in Serverprotokollen oder im Browserverlauf aufgezeichnet werden können.
  • Token-Bereich einschränken: Beschränken Sie Token auf das Minimum an notwendigen Berechtigungen, wie z.B. Lesezugriff, es sei denn, Schreibzugriff ist explizit erforderlich.
  • Token-Ablaufzeit festlegen: Verwenden Sie kurze Token-Lebensdauern, um das Risiko eines Token-Missbrauchs zu reduzieren. Erwägen Sie, die Lebensdauer von Tokens basierend auf Nutzungsmustern und Sicherheitsanforderungen zu begrenzen.
  • Aktivieren von Einmal-Token: Verwenden Sie nach Möglichkeit Einmal-Token für besonders sensible Aktionen, um sicherzustellen, dass sie nicht wiederverwendet werden können.
Scroll Up