VocalStack Logo

Documentation

Obter dados de transcrição

Obtenha dados de transcrições pendentes ou concluídas

Transcrever de um microfone ou LiveStream

Transcreva falas ao vivo de um microfone ou transmissão ao vivo

Sessões de transcrição

Monitore e gerencie o estado da transcrição com sessões

Traduzir uma transcrição

Traduza o texto transcrito para outro idioma

Transcrever áudio a partir de URL

Transcrever fala de áudio pré-gravado em um URL para texto simples

Tokens de autenticação do lado do cliente

Pedido e Resposta de Transcrição

Opções de solicitação e respostas comuns para todas as operações de transcrição

Transcrever e Apresentar uma Sessão Poliglota

Crie uma sessão que possa ser usada para transmitir uma transcrição ao vivo por meio de um link compartilhável público

Tokens de autenticação do lado do cliente

Procurar na documentação
Criar um token de autenticação temporário para solicitações do lado do cliente. Implemente solicitações de API com segurança em navegadores da Web sem expor suas chaves de API.
Os tokens de autenticação são uma medida de segurança essencial em ambientes de cliente onde você precisa de serviços de API VocalStack. Você precisará disso ao implementar solicitações de API em navegadores da Web, aplicativos ou qualquer outro ambiente público.

Gerar um token de autenticação

No lado do servidor, podemos usar o SDK para gerar um token de autenticação. Por padrão, as opções para o token são restritivas. Você pode querer atualizar estes para atender às suas necessidades:
  • access: Ou "readonly" ou "readwrite". O primeiro permite que você execute chamadas de API que retornam dados. O último permite que você também execute solicitações de API que incluem operações relacionadas a transcrição faturáveis. O valor padrão para esta opção é. "readonly".
  • lifetime_s: Um número entre 1 e 120 representando a vida útil do token em segundos. Após esse período, o token expirará e não será mais utilizável. Note que isso não afetará solicitações assíncronas que já tenham começado a usar esse token. (Em outras palavras, uma vez que uma solicitação assíncrona tenha sido iniciada, ela será executada até a conclusão, mesmo que o token tenha expirado após o início da solicitação. ) O valor padrão para esta opção é. 10.
  • one_time: Um booleano que indica se este token de API é destinado a um único uso. Se true, uma vez que este token foi usado para uma solicitação de API, ele expirará. O valor padrão para esta opção é. verdadeiro.
Veja como isso ficará no seu 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.
Você precisará configurar um mecanismo para servir o token API gerado pelo servidor para o cliente. Isso dependerá em grande parte da sua infraestrutura e da sua pilha de tecnologia. Certifique-se de implementar as melhores práticas de segurança. Por exemplo, não crie um endpoint de API que forneça tokens de API gerados para solicitações não autenticadas.

Usando um token de autenticação

Consumir a API VocalStack no lado do cliente requer que você use um authToken definição em vez de um apiKey. Por exemplo, considere a documentação para Transcrever áudio a partir de URL.
Neste exemplo, basta substituir:
{ apiKey: 'YOUR-API-KEY' } com { 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();

Considerações de segurança

Ao gerar e servir tokens de autenticação do lado do cliente, é crucial implementar medidas de segurança rigorosas para evitar o acesso não autorizado à sua API. Os tokens são ferramentas poderosas para aceder a recursos e serviços, e se não forem protegidos, podem ser utilizados de forma incorrecta. Você deve garantir que apenas clientes autorizados possam solicitar e usar tokens, e nunca deve expor dados confidenciais, como chaves de API, em um ambiente público. Não fazer isso pode resultar em violações de dados, acesso não autorizado a recursos ou cobranças não intencionais por serviços faturáveis.
Para ajudar a proteger sua implementação, considere as seguintes práticas recomendadas:
  • Nunca exponha suas chaves de API no lado do cliente: As chaves de API devem sempre permanecer confidenciais e ser armazenadas com segurança no servidor. Expô-los no código do lado do cliente (e. g. JavaScript, HTML) pode levar ao acesso não autorizado à API.
  • Use a geração de tokens do lado do servidor seguro: Sempre gere tokens de autenticação no lado do servidor para evitar a exposição de chaves de API no código do cliente.
  • Autenticar solicitações de tokens: Garanta que apenas usuários ou serviços autenticados possam solicitar um token de API, aplicando mecanismos de autenticação (por exemplo, o token de API). g. , OAuth, validação de sessão).
  • Implemente o HTTPS: Sempre servir tokens sobre HTTPS para proteger contra ataques de homem-no-meio.
  • Evite expor tokens em URLs: Nunca passe tokens em parâmetros de consulta de URL, pois eles podem ser registrados nos logs do servidor ou expostos no histórico do navegador.
  • Restringir o escopo do token: Limite os tokens para o mínimo de permissões necessárias, como acesso somente leitura, a menos que o acesso de gravação seja explicitamente necessário.
  • Definir expiração de token: Use tokens de curta duração para reduzir o risco de uso indevido de tokens. Considere limitar a vida útil dos tokens com base em padrões de uso e necessidades de segurança.
  • Habilitar tokens de uso único: Se possível, use tokens únicos para ações especialmente sensíveis para garantir que eles não possam ser reutilizados.
Scroll Up