Documentation

Pobierz dane transkrypcji

Pobiera dane z oczekujących lub ukończonych transkrypcji

Transkrypcja z mikrofonu lub LiveStream

Transkrypcja mowy na żywo z mikrofonu lub strumienia na żywo

Transkrypcja

Monitoruj i zarządzaj stanem transkrypcji z sesjami

Przetłumacz a Transscription

Przetłumacz transkrybowany tekst na inny język

Transkrypcja audio z URL

Transkrypcja mowy z nagranego dźwięku w URL do zwykłego tekstu

Żądanie transkrypcji i odpowiedź

Wspólne opcje żądania i odpowiedzi dla wszystkich operacji transkrypcji

Transkrypcja i prezentacja sesji poliglotycznej

Utwórz sesję, która może być użyta do transmisji transkrypcji na żywo za pośrednictwem publicznego łącza udostępniania

Tokeny uwierzytelniania po stronie klienta

Przeglądaj dokumentację
Utwórz tymczasowy token uwierzytelniania dla żądań po stronie klienta. Bezpiecznie implementuj żądania API w przeglądarkach internetowych bez ujawniania kluczy API.
Tokeny uwierzytelniania są niezbędnym środkiem bezpieczeństwa w środowiskach klienckich, w których wymagane są usługi VocalStack API. Będzie to wymagane podczas implementowania żądań API w przeglądarkach internetowych, aplikacjach lub innych środowiskach publicznych.
Po stronie serwera możemy użyć SDK do wygenerowania tokenu uwierzytelniającego. Domyślnie opcje dla tokenu są restrykcyjne. Możesz je zaktualizować, aby spełniały Twoje wymagania:
  • access: Albo "tylko do odczytu" albo "odczyt-zapis". Pierwszy z nich pozwala na wykonywanie wywołań API, które zwracają dane. Ta ostatnia umożliwia również wykonywanie żądań API, które obejmują operacje związane z rozliczaną transkrypcją. Wartość domyślna dla tej opcji to. "tylko do odczytu".
  • lifetime_s: Liczba pomiędzy 1 a 120 reprezentująca czas życia tokenu w sekundach. Po tym okresie token wygaśnie i nie będzie już użyteczny. Zauważ, że nie będzie to miało wpływu na żądania asynchroniczne, które już rozpoczęły używanie tego tokenu. (Innymi słowy, po uruchomieniu żądania asynchronicznego zostanie ono wykonane do końca, nawet jeśli token wygasł po rozpoczęciu żądania. ) Wartość domyślna dla tej opcji to. 10.
  • one_time: Boolean oznaczające, czy ten token API jest przeznaczony do jednorazowego użytku. Jeśli jest true, to po użyciu tego tokenu do żądania API, wygaśnie. Wartość domyślna dla tej opcji to. true.
Oto jak to będzie wyglądać na twoim serwerze:
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.
Będziesz musiał skonfigurować mechanizm do obsługi tokenu API wygenerowanego przez serwer dla klienta. Będzie to w dużej mierze zależało od infrastruktury i technologii. Upewnij się, że wdrożyłeś najlepsze praktyki bezpieczeństwa. Na przykład nie należy tworzyć punktu końcowego interfejsu API, który obsługuje wygenerowane tokeny interfejsu API dla nieuwierzytelnionych żądań.
Używanie VocalStack API po stronie klienta wymaga użycia. authToken setting instead of an apiKey. Na przykład, rozważ dokumentację dla Transkrypcja audio z URL.
W tym przykładzie po prostu zastąp:
{ 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();
Podczas generowania i obsługi tokenów uwierzytelniania po stronie klienta, kluczowe jest wdrożenie rygorystycznych środków bezpieczeństwa, aby zapobiec nieautoryzowanemu dostępowi do interfejsu API. Tokeny są potężnymi narzędziami dostępu do zasobów i usług, a jeśli nie są chronione, mogą być niewłaściwie wykorzystywane. Musisz upewnić się, że tylko autoryzowani klienci mogą żądać i używać tokenów, i nigdy nie powinieneś ujawniać poufnych danych, takich jak klucze API w środowisku publicznym. Niedopełnienie tego obowiązku może spowodować naruszenie bezpieczeństwa danych, nieautoryzowany dostęp do zasobów lub niezamierzone obciążenie usług płatnych.
Aby zabezpieczyć wdrożenie, należy rozważyć następujące najlepsze praktyki:
  • Nigdy nie ujawniaj kluczy API po stronie klienta: Klucze API powinny zawsze pozostawać poufne i bezpiecznie przechowywane na serwerze. Ujawnianie ich w kodzie po stronie klienta (e. g. JavaScript, HTML) może prowadzić do nieautoryzowanego dostępu do API.
  • Użyj bezpiecznego generowania tokenów po stronie serwera: Zawsze generuj tokeny uwierzytelniania po stronie serwera, aby zapobiec ujawnieniu kluczy API w kodzie klienta.
  • Uwierzytelnianie żądań tokenów: Zapewnij, że tylko uwierzytelnieni użytkownicy lub usługi mogą żądać tokenu API, wymuszając mechanizmy uwierzytelniania (np. g. , OAuth, walidacja sesji).
  • Wdrożyć HTTPS: Zawsze serwuj tokeny przez HTTPS, aby chronić się przed atakami typu man-in-the-middle.
  • Unikaj ujawniania tokenów w adresach URL: Nigdy nie przekazywać tokenów w parametrach zapytań URL, ponieważ mogą one zostać zarejestrowane w logach serwera lub wystawione w historii przeglądarki.
  • Zakres ograniczenia tokenu: Ogranicz tokeny do minimum niezbędnych uprawnień, takich jak dostęp tylko do odczytu, chyba że dostęp do zapisu jest wyraźnie wymagany.
  • Ustaw token wygaśnięcia: Używaj krótkich okresów życia tokenów, aby zmniejszyć ryzyko niewłaściwego użycia tokenów. Rozważ ograniczenie czasu życia tokenów w oparciu o wzorce użytkowania i potrzeby bezpieczeństwa.
  • Włącz jednorazowe tokeny użycia: Jeśli to możliwe, używaj jednorazowych tokenów do szczególnie wrażliwych akcji, aby upewnić się, że nie mogą być ponownie użyte.
Scroll Up