VocalStack Logo

Documentation

Получаване на данни за транскрипция

Получаване на данни от чакащи или завършени транскрипции

Преписване от микрофон или поток на живо

Преписвайте реч на живо от микрофон или поток на живо

Сесии за транскрипция

Наблюдавайте и управлявайте състоянието на транскрипцията със сесии

Превод на транскрипция

Превод на транскрибиран текст на друг език

Преписване на аудио от адрес

Транскрипция на реч от предварително записано аудио в URL към обикновен текст

Заявка и отговор за транскрипция

Общи опции за заявка и отговори за всички операции по транскрипция Използвайте опциите, за да конфигурирате настройките за транскрипция

Преписване и представяне на сесия на полиглот

Създаване на сесия, която може да се използва за излъчване на транскрипция на живо чрез публична споделяща връзка

Токени за удостоверяване от страна на клиента

Преглед на документацията
Създаване на временен знак за удостоверяване за клиентски заявки. Безопасно изпълнявайте заявки в уеб браузъри, без да излагате вашите ключове.
Токените за удостоверяване са важна мярка за сигурност в клиентски среди, където се изискват услуги от VocalStack API. Ще ви е необходимо това, когато изпълнявате заявки в уеб браузъри, приложения или други публични среди.
От страна на сървъра можем да използваме SDK за генериране на удостоверителен токен. По подразбиране, опциите за токен са ограничителни. Може да искате да актуализирате тези, за да отговарят на вашите изисквания:
  • access: Или "само за четене" или "записване". Първият ви позволява да изпълнявате API извиквания, които връщат данни. Последното ви позволява също така да изпълнявате API заявки, които включват операции, свързани с транскрипция. Стойността по подразбиране за тази опция е. "само за четене".
  • lifetime_s: Число между 1 и 120, представляващо живота на токен в секунди. След този период, токенът ще изтече и вече няма да бъде използваем. Имайте предвид, че това няма да повлияе на асинхронните заявки, които вече са започнали да използват този токен. (С други думи, след като е започнала асинхронна заявка, тя ще се изпълни до завършване, дори ако знакът е изтекъл след стартирането на заявката. ) Стойността по подразбиране за тази опция е. 10.
  • one_time: Булевото число, обозначаващо дали този API токен е предназначен за еднократна употреба. Ако е вярно, след като този токен е бил използван за API заявка, той ще изтече. Стойността по подразбиране за тази опция е. вярно.
Ето как ще изглежда това на вашия сървър:
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.
Ще трябва да настроите механизъм за обслужване на генерирания от сървъра API токен на клиента. Това ще зависи до голяма степен от вашата инфраструктура и технологичен пакет. Уверете се, че прилагате най-добрите практики за сигурност. Например не трябва да създавате крайна точка, която обслужва генерирани токени за неудостоверени заявки.
Консумирането на API от страна на клиента изисква да използвате. authToken настройка вместо apiKey. Например, разгледайте документацията за [тип на връзката="документация" код="d23c4ea1-0d15-4af6-b124-805ef2f12066"].
В този пример просто заменете:
{ apiKey: 'YOUR-API-KEY' } с { authToken: 'YOUR-AUTH-TOKEN' } 6.
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();
Когато генерирате и обслужвате клиентски удостоверителни токени, е от решаващо значение да прилагате строги мерки за сигурност, за да предотвратите неоторизиран достъп до вашия интерфейс. Токените са мощни инструменти за достъп до ресурси и услуги и ако не са защитени, могат да бъдат използвани неправилно. Трябва да се уверите, че само упълномощени клиенти могат да заявяват и използват токени, и никога не трябва да излагате чувствителни данни като ключове в публична среда. Ако не направите това, може да доведе до нарушения на сигурността на данните, неоторизиран достъп до ресурси или нежелани такси за платени услуги.
За да защитите внедряването си, помислете за следните най-добри практики:
  • Никога не излагайте ключовете си от страна на клиента: Ключовете на API трябва винаги да остават поверителни и да се съхраняват сигурно на сървъра. Излагането им в клиентски код (д. г. Неоторизиран достъп до API може да доведе до неоторизиран достъп до API.
  • Използвайте генериране на защитен токен от страна на сървъра: Винаги генерирай удостоверителни символи от страната на сървъра, за да предотвратиш излагането на API ключове в клиентския код.
  • Удостоверяване на заявки за токени: Уверете се, че само удостоверени потребители или услуги могат да поискат токен чрез прилагане на механизми за удостоверяване (т.е. г- н , валидиране на сесия).
  • Изпълнение на HTTPS: Винаги обслужвайте токени през HTTPS, за да се предпазите от атаки от типа „мъжът по средата“.
  • Избягвайте излагането на токени в адресите: Никога не предавайте токени в параметрите на заявката, тъй като те могат да бъдат записани в сървърните дневници или да бъдат изложени в историята на браузъра.
  • Ограничаване на обхвата на токен: Ограничаване на токените до минималните необходими разрешения, като например достъп само за четене, освен ако изрично не се изисква достъп за запис.
  • Задайте срок на валидност на токен: Използвайте кратки срокове на валидност на токените, за да намалите риска от злоупотреба с тях. Помислете за ограничаване на срока на живот на токен въз основа на модели на използване и нужди от сигурност.
  • Активиране на еднократни токени за употреба: Ако е възможно, използвайте еднократни токени за особено чувствителни действия, за да се гарантира, че те не могат да бъдат използвани повторно.
Scroll Up