VocalStack Logo

Documentation

Obtener datos de transcripción

Obtenga datos de transcripciones pendientes o completadas

Transcribir desde un micrófono o LiveStream

Transcribe el discurso en vivo desde un micrófono o transmisión en vivo

Sesiones de transcripción

Monitoree y administre el estado de transcripción con sesiones

Traducir una transcripción

Traducir texto transcrito a otro idioma

Transcribir audio desde URL

Transcribir el discurso de audio pregrabado en una URL a texto plano

Tokens de autenticación del lado del cliente

Solicitud y respuesta de transcripción

Opciones de solicitud y respuestas comunes para todas las operaciones de transcripción

Transcribir y presentar una sesión políglota

Crear una sesión que se pueda utilizar para transmitir una transcripción en vivo a través de un enlace público compartible

Tokens de autenticación del lado del cliente

Buscar en la documentación
Crear un token de autenticación temporal para solicitudes del lado del cliente. Implemente solicitudes de API de forma segura en navegadores web sin exponer sus claves de API.
Los tokens de autenticación son una medida de seguridad esencial en entornos de cliente donde se requieren servicios de API de VocalStack. Esto es necesario cuando se implementan solicitudes de API en navegadores web, aplicaciones o cualquier otro entorno público.

Generación de un token de autenticación

En el lado del servidor podemos usar el SDK para generar un token de autenticación. Por defecto, las opciones para el token son restrictivas. Es posible que desee actualizarlos para adaptarse a sus necesidades:
  • access: Ya sea "solo lectura" o "lectura-escritura". El primero le permite ejecutar llamadas a la API que devuelven datos. Este último le permite también ejecutar solicitudes de API que incluyen operaciones relacionadas con transcripción facturable. El valor por defecto para esta opción es. "solo para leer".
  • lifetime_s: Un número entre 1 y 120 que representa la vida útil del token en segundos. Después de este período, el token expirará y ya no será utilizable. Tenga en cuenta que esto no afectará a las solicitudes asíncronas que ya han comenzado a usar este token. (En otras palabras, una vez que una solicitud asíncrona ha comenzado, se ejecutará hasta su finalización, incluso si el token ha expirado después de que la solicitud haya comenzado. ) El valor por defecto para esta opción es. 10 de diciembre de 1999.
  • one_time: Un booleano que indica si este token de API está destinado a un solo uso. Si es true, una vez que este token se ha utilizado para una solicitud de API, expirará. El valor por defecto para esta opción es. true.
Esto es lo que se verá en su 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.
Necesitarás configurar un mecanismo para servir el token de API generado por tu servidor a tu cliente. Esto dependerá en gran medida de su infraestructura y pila de tecnología. Asegúrese de implementar las mejores prácticas de seguridad. Por ejemplo, no debes crear un extremo de API que proporcione tokens de API generados a solicitudes no autenticadas.

Uso de un token de autenticación

Para consumir la API de VocalStack en el lado del cliente, se requiere usar un. authToken setting en lugar de an apiKey. Por ejemplo, considere la documentación de Transcribir audio desde URL.
En este ejemplo simplemente reemplaza:
{ 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();

Consideraciones de seguridad

Al generar y servir tokens de autenticación del lado del cliente, es crucial implementar medidas de seguridad estrictas para evitar el acceso no autorizado a su API. Los tokens son herramientas poderosas para acceder a recursos y servicios, y si no están protegidos, pueden ser mal utilizados. Debe asegurarse de que solo los clientes autorizados puedan solicitar y usar tokens, y nunca debe exponer datos confidenciales como claves de API en un entorno público. De lo contrario, podrían producirse filtraciones de datos, acceso no autorizado a recursos o cargos no deseados por servicios facturables.
Para ayudar a proteger su implementación, considere las siguientes prácticas recomendadas:
  • Nunca exponga sus claves de API en el lado del cliente: Las claves de API siempre deben permanecer confidenciales y almacenarse de forma segura en el servidor. Exponerlos en el código del lado del cliente (e. g. JavaScript, HTML) puede conducir a un acceso no autorizado a la API.
  • Generación de tokens del lado del servidor seguro: Generar siempre tokens de autenticación en el lado del servidor para evitar la exposición de claves de API en el código del cliente.
  • Autenticar solicitudes de tokens: Asegúrese de que solo los usuarios o servicios autenticados puedan solicitar un token de API mediante la aplicación de mecanismos de autenticación (p. ej. g. , OAuth, validación de sesión).
  • Implementar HTTPS: Siempre sirve tokens a través de HTTPS para protegerse contra ataques de hombre en el medio.
  • Evite exponer tokens en URL: Nunca pase tokens en parámetros de consulta de URL ya que podrían ser registrados en los registros del servidor o expuestos en el historial del navegador.
  • Restringir el alcance del token: Limitar los tokens a los permisos mínimos necesarios, como el acceso de solo lectura a menos que se requiera explícitamente el acceso de escritura.
  • Establecer expiración de token: Utilice tokens de corta vida útil para reducir el riesgo de mal uso de tokens. Considere limitar la vida útil de los tokens en función de los patrones de uso y las necesidades de seguridad.
  • Habilitar tokens de uso único: Si es posible, utilice tokens de un solo uso para acciones especialmente sensibles para asegurarse de que no puedan ser reutilizados.
Scroll Up