@tiagohsf_gf/rekognition-embed
v2.0.0
Published
Interface biométrica desenvolvida para integração simples e segura em aplicações web.
Readme
🔐 Rekognition Embed Frontend
Interface biométrica desenvolvida para integração simples e segura em aplicações web.
🚀 Desenvolvido pela GF Innovation
🌐 https://gfinnovation.com.br/
✨ Sobre
O Rekognition Embed é um widget biométrico pronto para uso, projetado para ser incorporado em qualquer aplicação web com poucos passos.
Ele oferece suporte para:
- 🫥 Prova de Vida (Liveness)
- 👤 Biometria Facial
- 📄 OCR de Documentos
- 🎂 Estimativa de Idade
- 🔌 Integração via WebSocket ou API
- 🎨 Personalização visual e branding
- ⚡ Fácil incorporação em aplicações React, Angular ou JavaScript puro
🚀 Como utilizar
O pacote exporta a classe BiometriaEmbed, podendo ser utilizada de duas maneiras.
📦 1. Importando no projeto
import { BiometriaEmbed } from "@tiagohsf_gf/rekognition-embed";
const embed = BiometriaEmbed.init({
container: "#biometria-container",
sessionId: "sessao-123",
apiBaseUrl: "https://seu-backend.com",
modules: {
provaDeVida: true,
ageEstimation: false,
documentOcr: false,
facialBiometrics: false,
},
callbacks: {
onSuccess: (result) => {
console.log("Sucesso:", result);
},
onError: (error) => {
console.error("Erro:", error);
},
},
});🌎 2. Utilizando a versão global
Caso o bundle esteja carregado na página:
window.BiometriaEmbed.init({
container: "#biometria-container",
sessionId: "sessao-123",
apiBaseUrl: "https://seu-backend.com",
modules: {
provaDeVida: true,
ageEstimation: false,
documentOcr: false,
facialBiometrics: false,
},
});⚙️ Configuração mínima
Os parâmetros obrigatórios são:
| Propriedade | Descrição |
|--------------|------------|
| container | Elemento HTML ou seletor CSS onde o widget será renderizado |
| sessionId | Identificador da sessão biométrica |
| apiBaseUrl | URL da API backend |
| modules | Módulos que estarão habilitados |
Exemplo
BiometriaEmbed.init({
container: document.getElementById("biometria-container") as HTMLElement,
sessionId: "sessao-123",
apiBaseUrl: "http://localhost:8000",
modules: {
provaDeVida: true,
ageEstimation: false,
documentOcr: false,
facialBiometrics: false,
},
});🧩 Módulos disponíveis
| Módulo | Descrição |
|----------|-----------|
| 🫥 provaDeVida | Validação de presença humana |
| 👤 facialBiometrics | Comparação biométrica facial |
| 📄 documentOcr | Extração de dados de documentos |
| 🎂 ageEstimation | Estimativa de faixa etária |
🎨 Opções avançadas
O widget suporta diversas opções de personalização:
Interface
- 🎯
entryMode:autoouselection - 📷
captureMode:autooumanual - 💎
livenessUiVariant:minimaloupremium - 📐
size: largura, altura e tamanho máximo do widget
Comunicação
- 🔌
integrationMode:websocketoulegacy - 🔑
auth: token de autenticação
Personalização
- 🎨
theme: cores do widget - 🏢
company: informações da empresa - 🖼️
branding: logo e favicon personalizados
Eventos
- 🔄
callbacks: tratamento de eventos e respostas
🔔 Callbacks
Exemplo completo:
const embed = BiometriaEmbed.init({
container: "#biometria-container",
sessionId: "sessao-123",
apiBaseUrl: "https://seu-backend.com",
modules: {
provaDeVida: true,
ageEstimation: false,
documentOcr: false,
facialBiometrics: false,
},
callbacks: {
onStepChange: (step) => {
console.log("Etapa:", step);
},
onSuccess: (result) => {
console.log("Resultado final:", result);
},
onError: (error) => {
console.error("Erro do embed:", error);
},
},
});🛑 Encerrando o widget
Quando não for mais necessário, destrua a instância:
embed.destroy();📦 Exportações disponíveis
O pacote disponibiliza:
- 🔹
BiometriaEmbed - 🔹
BiometriaEmbedApi - 🔹 Tipagens em
src/sdk/types.ts
🏗️ Desenvolvido por GF Innovation
🌐 Website: https://gfinnovation.com.br/
📜 Licença
© GF Innovation. Todos os direitos reservados.
Este software é propriedade intelectual da GF Innovation e seu uso, distribuição ou reprodução estão sujeitos às políticas e termos definidos pela empresa.
