VocalStack Logo

Documentation

Obter os datos de transcrición

Obter datos de transcricións pendentes ou completadas

Transcreba desde un micrófono ou LiveStream

Transcreba o discurso en directo desde un micrófono ou unha transmisión en directo

Sesións de transcripción

Vixiar e xestionar o estado da transcrición con sesións

Traducir unha transcrición

Traducir o texto transcrito a outro idioma

Transcreba o son desde un URL

Transcríbe a voz de audio pregrabado nun URL a texto simple

Tokens de autenticación do lado do cliente

Solicitude e resposta de transcrición

Opcións de petición e respostas comúns para todas as operacións de transcrición

Transcreba e presente unha sesión de Polyglot

Crear unha sesión que se poida usar para difundir unha transcrición en directo mediante unha ligazón pública compartible

Tokens de autenticación do lado do cliente

Examinar a documentación
Crear un token de autenticación temporal para as solicitudes do lado do cliente. Implemente de forma segura as solicitudes da API nos navegadores web sen expor as súas chaves da API.
Os tokens de autenticación son unha medida de seguridade esencial nos ambientes de cliente onde se requiren servizos da API VocalStack. Requirirá isto cando implemente peticións de API en navegadores web, programas ou calquera outro ambiente público.

Xerar un token de autenticación

Do lado do servidor podemos usar o SDK para xerar un token de autenticación. Por omisión, as opcións para o token son restritivas. Pode que queira actualizar estes para axustarse aos seus requisitos:
  • access: Ou « só lectura » ou « lectura- escritura ». O primeiro permite executar chamadas á API que devolven datos. Este último permite tamén executar peticións de API que inclúen operacións relacionadas coa transcrición facturábeis. O valor por omisión para esta opción é. "só lectura".
  • lifetime_s: Un número entre 1 e 120 que representa a vida útil do token en segundos. Despois deste período, o token caducaría e deixaría de ser usable. Lembre que isto non afectará aos pedidos asíncronos que xa comezaron a usar este token. (Noutras palabras, unha vez que se iniciou un pedido asíncrono, executarase ata a súa finalización aínda que o token caducase despois de que se iniciase o pedido. ) O valor por omisión para esta opción é. 10.
  • one_time: Un booleano que indica se este token da API está destinado a un só uso. Se é verdadeiro, unha vez que este token sexa usado para unha solicitude de API, caducara. O valor por omisión para esta opción é. verdadeiro.
Aquí está como se verá no servidor:
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.
Precisará configurar un mecanismo para servir o token da API xerado polo servidor ao cliente. Isto dependerá en gran medida da túa infraestrutura e tecnoloxía. Asegúrese de implementar as mellores prácticas de seguridade. Por exemplo, non debería crear un punto final de API que sirva tokens de API xerados para peticións non autenticadas.

Usar un token de autenticación

Para usar a API de VocalStack no lado do cliente, é preciso empregar un authToken setting instead of an apiKey. Por exemplo, considere a documentación de .
Neste exemplo, simplemente substituír:
{ apiKey: 'YOUR-API-KEY' } con { 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();

Consideracións de seguridade

Ao xerar e servir tokens de autenticación do lado do cliente, é crucial implementar medidas de seguridade estritas para evitar o acceso non autorizado á súa API. Os tokens son ferramentas poderosas para acceder a recursos e servizos, e se non están protexidos, poden ser mal utilizados. Debe asegurarse de que só os clientes autorizados poden solicitar e usar tokens, e nunca debe expor datos sensibles como chaves de API nun ambiente público. O non facelo podería resultar en violacións de datos, acceso non autorizado a recursos ou cargas non intencionadas por servizos facturables.
Para axudar a protexer a súa implementación, considere as seguintes prácticas recomendadas:
  • Nunca expor as chaves da API no lado do cliente: As chaves da API deben permanecer sempre confidenciais e almacenadas de forma segura no servidor. Expoñelos no código do lado do cliente (e. de xuño JavaScript, HTML) pode levar a acceso non autorizado á API.
  • Empregar a xeración segura de tokens do lado do servidor: Xerar sempre tokens de autenticación no lado do servidor para evitar a exposición de chaves API no código do cliente.
  • Autenticar os pedidos de tokens: Asegura que só os usuarios ou servizos autenticados poidan solicitar un token API forzando mecanismos de autenticación (e. g. g , OAuth, validación de sesión).
  • Implementar HTTPS: Sempre servir tokens sobre HTTPS para protexer contra ataques man-in-the-middle.
  • Evitar expor os tokens nos URL: Nunca pase tokens nos parámetros de consulta de URL xa que poderían ser rexistrados nos rexistros do servidor ou expostos no historial do navegador.
  • Restrición do alcance do token: Limitar os tokens aos permisos mínimos necesarios, como o acceso de só lectura a menos que se requira explicitamente o acceso de escritura.
  • Establecer o caducar do token: Usar tempos de vida curtos para os tokens para reducir o risco de mal uso dos tokens. Considere limitar a vida útil dos tokens baseándose nos patróns de uso e nas necesidades de seguridade.
  • Activar os tokens de uso único: Se é posible, use tokens de uso único para accións especialmente sensibles para asegurarse de que non poidan ser reutilizados.
Scroll Up