VocalStack Logo

Documentation

Получить данные транскрипции

Получить данные из ожидающих или завершенных транскрипций

Транскрипция с микрофона или LiveStream

Переписать речь в прямом эфире с микрофона или поток

Сеансы транскрипции

Мониторинг и управление состоянием транскрипции с помощью сеансов

Перевести транскрипцию

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

Транскрипция аудио из URL

Транскрипция речи из заранее записанного аудио в URL в обычный текст

Запрос и ответ на транскрипцию

Общие параметры запроса и ответы для всех операций транскрипции

Транскрипция и презентация сеанса полиглота

Создать сеанс, который может быть использован для трансляции транскрипции в реальном времени через публичную ссылку для совместного использования

Токены проверки подлинности на стороне клиента

Просмотр документации
Создать временный токен проверки подлинности для запросов со стороны клиента. Безопасно реализуйте API-запросы в веб-браузерах, не раскрывая свои API-ключи.
Токены аутентификации являются важной мерой безопасности в клиентских средах, где требуются услуги API VocalStack. Это будет необходимо при реализации запросов API в веб-браузерах, приложениях или любых других публичных средах.
На стороне сервера мы можем использовать SDK для генерации аутентификационного токена. По умолчанию параметры для токена ограничены. Возможно, вам захочется обновить их в соответствии с вашими требованиями:
  • access: Либо "только для чтения", либо "для чтения-записи". Первый позволяет выполнять вызов API, который возвращает данные. Последняя позволяет также выполнять запросы API, которые включают операции, связанные с платной транскрипцией. Значение по умолчанию для этого параметра "только для чтения".
  • lifetime_s: Число от 1 до 120, представляющее время жизни токена в секундах. По истечении этого периода токен истечет и больше не будет использоваться. Обратите внимание, что это не повлияет на асинхронные запросы, которые уже начали использовать этот токен. (Иными словами, после начала асинхронного запроса он будет выполняться до завершения, даже если после начала запроса истек срок действия токена. ) Значение по умолчанию для этой опции. 10-е заседание.
  • one_time: Логическое значение, указывающее, предназначен ли этот токен API для одноразового использования. Если true, то после того, как этот токен будет использован для запроса 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, которая обслуживает сгенерированные токены API для запросов без проверки подлинности.
Для использования API VocalStack на стороне клиента необходимо использовать authToken установка вместо apiKey. Например, рассмотрим документацию для Транскрипция аудио из URL.
В этом примере просто заменить:
{ 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 должны всегда оставаться конфиденциальными и безопасно храниться на сервере. Выявление их в клиентском коде (e. Г. JavaScript, HTML) может привести к несанкционированному доступу к API.
  • Использование генерации безопасных токенов на стороне сервера: Всегда генерировать токены аутентификации на стороне сервера, чтобы предотвратить раскрытие ключей API в клиентском коде.
  • Проверка подлинности запросов на токены: Убедитесь, что только проверенные пользователи или службы могут запрашивать токены API, применив механизмы проверки подлинности (например, проверку подлинности на основе ключей). g. Система управления , OAuth, проверка сеанса).
  • Внедрение HTTPS: Всегда обслуживать токены через HTTPS для защиты от атак «человек посередине».
  • Избегайте раскрытия токенов в URL: Никогда не передавайте токены в параметрах запроса URL, так как они могут быть зарегистрированы в журналах сервера или открыты в истории браузера.
  • Ограничить область применения токена: Ограничение токенов минимальными необходимыми разрешениями, такими как доступ только для чтения, если не требуется доступ для записи.
  • Установить срок действия токена: Используйте короткие сроки жизни токенов, чтобы уменьшить риск неправильного использования токенов. Рассмотрите возможность ограничения срока службы токенов в зависимости от схем использования и потребностей безопасности.
  • Включить одноразовые токены: По возможности, используйте одноразовые токены для особо чувствительных действий, чтобы убедиться, что они не могут быть использованы повторно.
Scroll Up