VocalStack Logo

Documentation

Átírási adatok beolvasása

Adatok lekérése függőben lévő vagy befejezett átiratokból

Átírás mikrofonról vagy élő közvetítésről

Élő beszéd átírása mikrofonról vagy élő közvetítésről

Átírási munkamenetek

A transzkripciós állapot figyelése és kezelése munkamenetekkel

Fordíts le egy átiratot

Átírt szöveg fordítása másik nyelvre

Hang átírása URL-ről

A beszéd átírása előre rögzített hangból egy URL-ben egyszerű szöveggé

Átírási kérelem és válasz

Az összes átírási művelethez tartozó közös kérési beállítások és válaszok: A beállítások használatával konfigurálhatja az átírási beállításokat

Átírja és bemutatja a Polyglot Session

Hozzon létre egy munkamenetet, amelyet egy élő átirat közvetítésére használhat egy nyilvános megosztható linken keresztül

Ügyféloldali hitelesítési tokenek

Dokumentáció böngészése
Ideiglenes hitelesítési token létrehozása az ügyféloldali kérelmekhez. API-kéréseket biztonságosan hajthat végre webböngészőben az API-kulcsok felfedése nélkül.
A hitelesítési tokenek alapvető biztonsági intézkedések olyan kliens környezetekben, ahol VocalStack API szolgáltatásokra van szükség. Erre akkor lesz szüksége, ha API-kéréseket hajt végre webböngészőben, alkalmazásban vagy bármilyen más nyilvános környezetben.
A szerver oldalon az SDK-t használhatjuk egy hitelesítési token létrehozására. Alapértelmezés szerint a token beállításai korlátozóak. Lehet, hogy frissíteni szeretné ezeket az igényeinek megfelelően:
  • access: Vagy "csak olvasás" vagy "írás". Az előbbi lehetővé teszi, hogy olyan API hívásokat hajtsunk végre, amelyek adatokat adnak vissza. Az utóbbi lehetővé teszi, hogy olyan API kéréseket is végrehajthasson, amelyek számlázható átírási műveleteket is tartalmaznak. Az alapértelmezett érték ennek az opciónak a. "csak olvasható".
  • lifetime_s: Egy 1 és 120 közötti szám, amely a token élettartamát jelzi másodpercben. Ezen időszak után a token lejár és már nem használható. Megjegyzendő, hogy ez nem érinti az aszinkron kéréseket, amelyek már ezzel a tokennel indultak. (Más szóval, ha egy aszinkron kérelem elindult, akkor is befejeződik, ha a jogkivonat lejárt a kérelem indítása után. ) Az alapértelmezett érték ennek az opciónak a. 10. szám.
  • one_time: A logikai érték, amely jelzi, hogy ez az API token egyszeri használatra szolgál. Ha igaz, akkor miután ezt a tokent felhasználták egy API kéréshez, lejár. Az alapértelmezett érték ennek az opciónak a. igaz.
Így fog ez kinézni a szerveren:
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.
Be kell állítanod egy mechanizmust, amivel a szerver által generált API tokent kiszolgálhatod a kliensednek. Ez nagyban függ az infrastruktúrától és a technológiai állománytól. Győződjön meg róla, hogy a legjobb biztonsági gyakorlatokat alkalmazza. Például ne hozzon létre olyan API-végpontot, amely generált API-jogkivonatokat szolgáltat a nem hitelesített kérelmekhez.
A VocalStack API felhasználása a kliens oldalon megköveteli, hogy használjon egy. authToken beállítás helyett egy apiKey.Például vegyük a Hang átírása URL-ről dokumentációját.
Ebben a példában egyszerűen cserélje ki:
{ apiKey: 'YOUR-API-KEY' } with { authToken: 'YOUR-AUTH-TOKEN' } 6. sz.
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();
A kliensoldali hitelesítési tokenek generálásakor és kiszolgálásakor alapvető fontosságú, hogy szigorú biztonsági intézkedéseket vezessünk be az API-hoz való jogosulatlan hozzáférés megakadályozása érdekében. A tokenek hatékony eszközök az erőforrásokhoz és szolgáltatásokhoz való hozzáféréshez, és ha nem védettek, visszaélhetnek velük. Biztosítania kell, hogy csak az engedéllyel rendelkező ügyfelek kérhessenek és használhassanak tokeneket, és soha ne tegye nyilvános környezetben érzékeny adatokat, például API-kulcsokat. Ennek elmulasztása adatsértést, az erőforrásokhoz való jogosulatlan hozzáférést vagy a számlázható szolgáltatásokért felszámított nem kívánt díjakat eredményezhet.
A megvalósítás biztonságának megőrzése érdekében vegye figyelembe az alábbi ajánlott eljárásokat:
  • Soha ne tegye ki az API-kulcsokat a kliens oldalon: Az API kulcsokat mindig bizalmasan kell kezelni és biztonságosan kell tárolni a szerveren. A kliens oldali kódban való megjelenítésük (e. 2008. szeptember 1. JavaScript, HTML) jogosulatlan hozzáférést eredményezhet az API-hoz.
  • Használja a biztonságos szerveroldali tokengenerálást: Mindig generáljon hitelesítési tokeneket a szerver oldalon, hogy megakadályozza az API kulcsok felfedését a kliens kódban.
  • Tokenek iránti kérelmek hitelesítése: Biztosítsa, hogy csak a hitelesített felhasználók vagy szolgáltatások kérhessenek API tokeneket a hitelesítési mechanizmusok érvényesítésével (pl. g. , OAuth, munkamenet érvényesítés).
  • A HTTPS implementálása: A tokeneket mindig HTTPS-en keresztül szolgálja ki, hogy megvédje a köztes támadásokkal szemben.
  • Kerülje a tokenek URL-ekben való megjelenítését: Soha ne adjon át tokeneket URL lekérdezési paraméterekben, mivel ezeket a szerver naplói vagy a böngésző előzményei láthatják.
  • Token hatókör korlátozása: A tokenekre a minimálisan szükséges jogosultságokat korlátozzuk, mint például a csak olvasási hozzáférés, kivéve, ha az írási hozzáférés kifejezetten szükséges.
  • Token lejárati idő beállítása: A tokenek rövid élettartama csökkenti a tokenekkel való visszaélés kockázatát. Fontolja meg a tokenek élettartamának korlátozását a használati minták és a biztonsági igények alapján.
  • Egyszer használatos tokenek engedélyezése: Ha lehetséges, használjunk egyszer használatos tokeneket a különösen érzékeny műveletekhez, hogy ne lehessen őket újra felhasználni.
Scroll Up