Documentation

Získání dat přepisu

Získejte data z čekajících nebo dokončených přepisů

Přepis z mikrofonu nebo LiveStream

Přepisujte živou řeč z mikrofonu nebo živého streamu

Přepisovací sezení

Monitorování a správa stavu přepisu pomocí relací

Přeložit přepis

Přeložit přepsaný text do jiného jazyka

Přepisovat zvuk z URL

Přepis řeči z předem nahraného zvuku v URL do prostého textu

Žádost o přepis a odpověď

Společné možnosti požadavků a odpovědí pro všechny operace přepisu

Přepisujte a prezentujte polyglot session

Vytvořte relaci, kterou lze použít k vysílání živého přepisu prostřednictvím veřejného sdíleného odkazu

Tokeny ověřování na straně klienta

Procházet dokumentaci
Vytvořit dočasný token ověření pro požadavky na straně klienta. Bezpečně implementujte požadavky API ve webových prohlížečích bez odhalení klíčů API.
Autentizační tokeny jsou nezbytným bezpečnostním opatřením v klientských prostředích, kde vyžadujete služby VocalStack API. To budete potřebovat při implementaci požadavků API ve webových prohlížečích, aplikacích nebo jiných veřejných prostředích.
Na straně serveru můžeme použít SDK pro generování autentizačního tokenu. Ve výchozím nastavení jsou možnosti pro token restriktivní. Možná budete chtít tyto aktualizovat tak, aby vyhovovaly vašim požadavkům:
  • access: Buď "jen pro čtení" nebo "pro čtení a zápis". První z nich umožňuje provádět volání API, která vracejí data. Druhý z nich vám umožňuje také provádět požadavky API, které zahrnují zpoplatněné operace související s přepisem. Výchozí hodnota pro tuto možnost je. "pouze pro čtení".
  • lifetime_s: Číslo mezi 1 a 120 představující životnost tokenu v sekundách. Po uplynutí této doby token vyprší a nebude již použitelný. Všimněte si, že to neovlivní asynchronní požadavky, které již začaly používat tento token. (Jinými slovy, jakmile byl spuštěn asynchronní požadavek, bude spuštěn až do dokončení, i když vypršela platnost tokenu po spuštění požadavku. ) Výchozí hodnota pro tuto možnost je. 10.
  • one_time: Boolean označující, zda je tento token API určen pro jednorázové použití. Pokud je true, poté, co byl tento token použit pro požadavek API, vyprší. Výchozí hodnota pro tuto možnost je. true.
Tady je návod, jak to bude vypadat na vašem serveru:
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.
Budete muset nastavit mechanismus pro poskytování tokenu API generovaného serverem vašemu klientovi. To bude do značné míry záviset na vaší infrastruktuře a technologickém zázemí. Ujistěte se, že implementujete osvědčené bezpečnostní postupy. Neměli byste například vytvářet koncový bod rozhraní API, který poskytuje generované tokeny rozhraní API neověřeným požadavkům.
Spotřeba VocalStack API na straně klienta vyžaduje použití. authToken nastavení místo apiKey. Vezměme si například dokumentaci pro Přepisovat zvuk z URL.
V tomto příkladu jednoduše nahraďte:
{ 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();
Při generování a poskytování tokenů pro ověřování na straně klienta je důležité zavést přísná bezpečnostní opatření, která zabrání neoprávněnému přístupu k vašemu API. Tokeny jsou mocnými nástroji pro přístup ke zdrojům a službám, a pokud nejsou chráněny, lze je zneužít. Musíte zajistit, aby tokeny mohli vyžadovat a používat pouze oprávnění klienti, a nikdy byste neměli ve veřejném prostředí zveřejňovat citlivá data, jako jsou klíče API. Pokud tak neučiníte, může to vést k narušení dat, neoprávněnému přístupu k prostředkům nebo k nechtěným poplatků za zpoplatněné služby.
Chcete-li zabezpečit implementaci, zvažte následující doporučené postupy:
  • Nikdy nevystavujte své klíče API na straně klienta: Klíče API by měly vždy zůstat důvěrné a bezpečně uložené na serveru. Vystavení je v klientském kódu (e. g. JavaScript, HTML) může vést k neoprávněnému přístupu k API.
  • Použití generování zabezpečených tokenů na straně serveru: Vždy generovat autentizační tokeny na straně serveru, aby se zabránilo odhalení API klíčů v klientském kódu.
  • Ověřování požadavků na tokeny: Zajistěte, aby token API mohli vyžádat pouze ověření uživatelé nebo služby, a to vynucením mechanismů ověření (např. g. , OAuth, ověření relace).
  • Implementujte protokol HTTPS: Vždycky poskytovat tokeny přes HTTPS k ochraně proti útokům typu man-in-the-middle.
  • Vyhněte se zobrazování tokenů v adresách URL: Nikdy nepředávejte tokeny v parametrech URL dotazu, protože by mohly být zaznamenány v protokolech serveru nebo v historii prohlížeče.
  • Omezit rozsah tokenu: Omezit tokeny na minimální potřebná oprávnění, jako je přístup pouze pro čtení, pokud není explicitně vyžadován přístup pro zápis.
  • Nastavit token vypršení platnosti: Používejte tokeny s krátkou životností, abyste snížili riziko zneužití tokenů. Zvažte omezení životnosti tokenů na základě vzorců použití a potřeb zabezpečení.
  • Povolit jednorázové tokeny: Pokud je to možné, používejte jednorázové tokeny pro zvláště citlivé akce, abyste zajistili, že nebudou znovu použity.
Scroll Up