Tipos de Erro
O SDK categoriza erros em tipos específicos para facilitar o tratamento:Estrutura do Erro
Tratamento de Erros
Usando Callback
Usando try/catch
Mensagens Amigáveis
Converta erros técnicos em mensagens compreensíveis para o usuário:Boas Práticas
Segurança
API Key
Nunca exponha a API Key no código frontend em produção. Use variáveis de
ambiente ou carregue de um endpoint seguro.
Arquivo CEK
Mantenha o CEK em um endpoint com autenticação. Considere carregá-lo
dinamicamente quando necessário.
HTTPS
O SDK requer conexão segura em produção. Sempre use HTTPS.
Validação
Valide os resultados no seu backend antes de confiar neles.
Performance
1
Pré-carregue o CEK
Carregue o CEK antes do usuário iniciar a verificação para evitar delays.
2
Container com dimensões fixas
Defina dimensões fixas no container para evitar reflows durante a
renderização.
3
Cleanup adequado
Sempre chame
teardown() ao desmontar o componente ou navegar para outra
página.Experiência do Usuário
Feedback Visual
Use os callbacks
onProgress para mostrar feedback ao usuário durante cada
etapa.Mensagens Claras
Traduza os erros técnicos em mensagens compreensíveis para o usuário final.
Instruções Claras
Personalize as instruções para seu público-alvo usando
hubOptions.strings.Ambiente Adequado
Oriente o usuário sobre iluminação e posicionamento antes de iniciar a
verificação.
Integração com Frameworks
Serviço Reutilizável
Checklist de Verificação
Antes de reportar um problema, verifique os itens abaixo:1
SDK Carregado
Confirme que o script do SDK foi carregado corretamente (
ValidHub está
disponível globalmente).2
CEK Válido
O arquivo CEK está acessível e não expirou.
3
Credenciais
API Key e Backend URL estão corretos.
4
Container
O elemento container existe no DOM antes de chamar
hub.run().5
HTTPS
A página está sendo servida via HTTPS (obrigatório para acesso à câmera).
6
Permissões
O navegador tem permissão para acessar a câmera.