face-sdk v1.0.0
BiopassID Face SDK Web
Componente web de integração do Biopass ID
Getting started
Com um bundler
Intale a dependencia:
npm i --save face-sdk
Utilize no seu projeto
import { useMultibiometrics } from 'face-sdk-web'
Através de CDN
Adicione o script ao projeto e serão injetados os quatro modulos globalmente ao projeto
<script src="../../../dist/unpkg/biopass.min.js"></script>
<script>
const { enroll } = useMultibiometrics("your key");
</script>
Modulos
O sdk web do Biopass id possui 4 módulos
- useMultibiometrics
- useQuality
- useMultibiometricServices
- useQualityServices
useMultibiometrics
O módulo useMultibiometrics oferece as seguintes funcionalidades.
import { useMultibiometrics } from 'face-sdk-web'
const {
enroll,
verify,
updatePerson,
deletePerson,
extract,
faceDetect,
faceSpoof,
anonymizer
} = useMultibiometrics("your key");
1. Enroll
Operação de cadastro de um indivíduo.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { enroll } = useMultibiometrics("your key");
async function handleEnroll() {
const resp = await enroll({
element: document.querySelector("#elementId"),
customId: "person custom id",
})
}
- Signature
enroll(params: PersonHookParams): Promise<PersonResponseDTO>
2. Verify
Operação de verificação.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { verify } = useMultibiometrics("your key");
async function handleVerify() {
const resp = await verify({
element: document.querySelector("#elementId"),
customId: "your custom id",
})
}
- Signature
verify(params: PersonHookParams): Promise<VerifyResponseDTO>
3. Update Person
Operação de atualização dos dados de um indivíduo.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { updatePerson } = useMultibiometrics("your key");
async function handleUpdatePerson() {
const resp = await updatePerson({
element: document.querySelector("#elementId"),
customId: "your custom id",
})
}
- Signature
updatePerson(params: PersonHookParams): Promise<PersonResponseDTO>
4. Delete Person
Operação de deleção do registro de um indivíduo.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { deletePerson } = useMultibiometrics("your key");
async function handleDeletePerson() {
const resp = await deletePerson({
element: document.querySelector("#elementId"),
customId: "your custom id",
})
}
- Signature
deletePerson(params: PersonHookParams): Promise<Partial<PersonResponseDTO>>
5. Extract
Operação de extração de template de uma imagem biométrica (face ou impressão digital).
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { extract } = useMultibiometrics("your key");
async function handleExtract() {
const resp = await extract({
element: document.querySelector("#elementId"),
customId: "your custom id",
})
}
- Signature
extract(params: ExtractHookParams): Promise<ExtractResponseDTO>
5. Face Detect
Operação de detecção de face.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { faceDetect } = useMultibiometrics("your key");
async function handleFaceDetect() {
const resp = await faceDetect({
element: document.querySelector("#camera"),
})
}
- Signature
faceDetect(params: BaseHookParams): Promise<CheckResponseDTO>
5. Face Spoof
Operação de deteção de spoofing em imagens de face.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { faceSpoof } = useMultibiometrics("your key");
async function handleFaceSpoof() {
const resp = await faceSpoof({
element: document.querySelector("#camera"),
})
}
- Signature
faceSpoof(params: BaseHookParams): Promise<SpoofResponseDTO>
5. Face Spoof
Operação de deteção de spoofing em imagens de face.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { faceSpoof } = useMultibiometrics("your key");
async function handleFaceSpoof() {
const resp = await faceSpoof({
element: document.querySelector("#camera"),
})
}
- Signature
faceSpoof(params: BaseHookParams): Promise<SpoofResponseDTO>
5. anonymizer
Operação de anonimização de faces.
- Example
import { useMultibiometrics } from 'face-sdk-web'
const { anonymizer } = useMultibiometrics("your key");
async function handleAnonymizer() {
const resp = await anonymizer({
element: document.querySelector("#camera"),
})
}
- Signature
anonymizer(params: BaseHookParams): Promise<AnonymizerResponseDTO>
useQuality
O módulo useQuality oferece as seguintes funcionalidades.
import { useQuality } from 'face-sdk-web'
const {
icaoQualityCheck,
icaoCrop,
} = useMultibiometrics("your key");
1. ICAO Quality Check
Operação de avaliação de imagens de foto de face segundo o padrão ISO/IEC 19794-5, ICAO.
- Example
import { useQuality } from 'face-sdk-web'
const { icaoQualityCheck } = useQuality("your key");
async function handleIcaoQualityCheck() {
const resp = await icaoQualityCheck({
element: document.querySelector("#camera"),
})
}
- Signature
icaoQualityCheck(params: BaseHookParams): Promise<IcaoResponseDTO>
2. ICAO Crop
Operação de recorte de uma imagem de foto de face segundo o padrão ISO/IEC 19794-5, ICAO.
- Example
import { useQuality } from 'face-sdk-web'
const { icaoCrop } = useQuality("your key");
async function handleIcaoCrop() {
const resp = await icaoCrop({
element: document.querySelector("#camera"),
})
}
- Signature
icaoCrop(params: BaseHookParams): Promise<IcaoCropResponseDTO>
useMultibiometricServices
O módulo useMultibiometricServices oferece funções facilitadoras para as chamadas HTTP dos serviços do Biopass. Ele provê as seguintes funcionalidades
import { useMultibiometricServices } from 'face-sdk-web'
const {
enrollService,
updateService,
deleteService,
verifyService,
matchService,
extractService,
wsqEncode,
wsqDecode,
faceDetectService,
faceSpoofService,
anonymizerService,
} = useMultibiometricServices("your key");
1. Enroll Service
enrollService(params: PersonParams): Promise<PersonResponseDTO>
2. Update Service
updateService(params: PersonParams): Promise<PersonResponseDTO>
3. Delete Service
deleteService(params: PersonParams): Promise<PersonResponseDTO>
4. Verify Service
verifyService(params: PersonParams): Promise<PersonResponseDTO>
5. Match Service
matchService(params: MatchParams): Promise<MatchResponseDTO>
6. Extract Service
extractService(params: ExtractParams): Promise<ExtractResponseDTO>
7. WSQ Encode Service
wsqEncode(params: WSQEncodeParams): Promise<WSQEncodeResponseDTO>
8. WSQ Decode Service
wsqDecode(params: ImageParams): Promise<WSQDecodeResponseDTO>
9. Face Detect Service
faceDetectService(params: ImageParams): Promise<CheckResponseDTO>
10. Face Spoof Service
faceSpoofService(params: ImageParams): Promise<SpoofResponseDTO>
11. Face Spoof Service
anonymizerService(params: ImageParams): Promise<AnonymizerResponseDTO>
useQualityServices
O módulo useQualityServices oferece funções facilitadoras para as chamadas HTTP dos serviços do Biopass. Ele provê as seguintes funcionalidades
import { useQualityServices } from 'face-sdk-web'
const {
icaoQualityCheckService,
icaoCropService,
checkNfiqService,
} = useQualityServices("your key");
1. Icao Quality Check Service
icaoQualityCheckService(params: ImageParams): Promise<IcaoResponseDTO>
2. Icao Crop Service Service
icaoCropService(params: ImageParams): Promise<PersonResponseDTO>
3. Delete Service
checkNfiqService(params: ImageParams): Promise<NFIQResponseDTO>
Interfaces
PersonHookParams
Param | Type | Required | Description |
---|---|---|---|
customId | string | true | Identificador do indivíduo, informado na requisição |
element | HTMLElement | true | Elemento HTML que o conteúdo será renderizado |
styles | Styles | false | Estilização |
options | Options | false | Opções de renderização |
cameraPresets | CameraPresets | false | Presets da camera |
PersonResponseDTO
{
Person: {
ClientID: string;
CustomID: string;
BioPassID: string;
}
}
2 years ago