diff --git a/docs.en-us/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md b/docs.en-us/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md new file mode 100644 index 00000000..1f6aff3f --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md @@ -0,0 +1,4 @@ +# Geolocation configuration - Rest PKI Core + + +
\ No newline at end of file diff --git a/docs.en-us/articles/toc.md b/docs.en-us/articles/toc.md index 88e23156..d78bbea6 100644 --- a/docs.en-us/articles/toc.md +++ b/docs.en-us/articles/toc.md @@ -111,6 +111,9 @@ #### [Authentication](rest-pki/core/integration/bio-sessions/authentication.md) #### [Identification](rest-pki/core/integration/bio-sessions/identification.md) #### [Identification Document Capture](rest-pki/core/integration/bio-sessions/id-capture.md) +#### Settings +##### [Identifier formats](rest-pki/core/integration/bio-sessions/configs/subject-identifier-formats.md) +##### [Geolocation](rest-pki/core/integration/bio-sessions/configs/geolocation.md) ### [Referencing files](rest-pki/core/integration/file-referencing.md) ### [Webhooks](rest-pki/core/integration/webhooks.md) ### [Error codes](rest-pki/core/integration/error-codes.md) diff --git a/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md b/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md new file mode 100644 index 00000000..35405163 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/configs/geolocation.md @@ -0,0 +1,33 @@ +# Configuração de geolocalização (Geolocation) - Rest PKI Core + +Durante uma sessão de biometria, o Rest PKI Core pode capturar a localização geográfica do dispositivo do usuário (latitude e longitude). O recurso vem **desligado por padrão**, essa é uma característica do software e pode ser ligado pelo painel, passando a valer para todas as sessões da sua aplicação. Em instâncias próprias (on-premises), o mesmo padrão também pode ser definido diretamente no `appsettings`, na seção `Bio`. + +Existem três configurações: + +- **Tipo de captura de geolocalização** — define se a localização é capturada e se ela é obrigatória: + - **Desabilitado** (padrão): a localização não é capturada. + - **Opcional**: o sistema tenta capturar a localização, mas a sessão continua normalmente caso o usuário não dê permissão ou a captura falhe. + - **Obrigatório**: a sessão só prossegue se a localização for capturada com sucesso. + - **Melhor esforço**: o sistema tenta capturar a localização sem nunca interromper a sessão, reenviando automaticamente falhas transitórias (por padrão, até 3 tentativas). Se todas as tentativas falharem, a sessão continua normalmente sem a localização. +- **Política de captura de geolocalização** — define em quais aparelhos a localização é coletada (importante nos fluxos com QR code, em que a biometria é feita no celular): + - **Coletar no dispositivo de captura** (padrão): coleta apenas no aparelho que faz a biometria (ex.: o celular). + - **Coletar em todos os dispositivos**: coleta tanto no computador que iniciou a sessão quanto no celular que fez a biometria. +- **Exibir etapa de captura na geolocalização best-effort** — só aparece quando o **Tipo de captura de geolocalização** está definido como **Melhor esforço**: + - **Ligado** (padrão): o usuário vê uma etapa pedindo a permissão de localização, porém sem os botões de cancelar ou pular. + - **Desligado**: a captura acontece sem nenhuma etapa própria do Rest PKI Core. Mesmo assim, o navegador do usuário pode exibir seu próprio pedido de permissão de localização, caso ele ainda não tenha decidido sobre ela. + +## Como configurar pelo painel + +1. Autentique-se no painel de controle da sua instância. +1. No menu lateral, clique em **Configurações**. +1. Localize a seção **"Configurações de biometria"** e clique em **Editar**. +![image](../../../../../../../images/rest-pki/core/geolocation-bio-settings.png) +1. No campo **Tipo de captura de geolocalização**, escolha **Opcional**, **Obrigatório** ou **Melhor esforço** para ligar o recurso. +1. Se desejar, ajuste a **Política de captura de geolocalização** (esse campo só aparece quando a captura está ligada). +![image](../../../../../../../images/rest-pki/core/geolocation-values.png) +1. Se escolheu **Melhor esforço**, ajuste também a opção **Exibir etapa de captura na geolocalização best-effort** para **desabilitado**, caso não queira mostrar a etapa de permissão ao usuário. +![image](../../../../../../../images/rest-pki/core/geolocation-best-effort.png) +1. Clique em **Salvar** para aplicar as configurações. + +> [!TIP] +> Integrando via API? Você pode definir a geolocalização por sessão, sobrescrevendo o padrão configurado aqui — veja [Parâmetros de geolocalização](../index.md#geolocation). \ No newline at end of file diff --git a/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/index.md b/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/index.md index a554cd21..4eb0abec 100644 --- a/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/index.md +++ b/docs.pt-br/articles/rest-pki/core/integration/bio-sessions/index.md @@ -186,7 +186,7 @@ Ao iniciar uma sessão, você deve configurar os parâmetros que definem como o O `SubjectIdentifier` é um campo que vincula a sessão de biometria a uma pessoa específica que está utilizando o seu sistema. Para as sessões de cadastro biométrico e autenticação biométrica, o `SubjectIdentifier` é o identificador único relacionado à aquela pessoa que você deseja cadastrar ou autenticar no sistema de biometria. - + Para as sessões anônimas, como Liveness e captura de documentos, esse identificador é indexado e poderá ser utilizado para encontrar o histórico de sessões com aquele identificador. > [!tip] @@ -198,6 +198,31 @@ Caso queira aceitar apenas alguns tipos de identificadores específicos, você p - **FaceCaptureProvider:** Define qual tecnologia de captura será utilizada na sessão de biometria. - Atualmente o único provedor utilizado pelo sistema é o `FaceTecLiveness3d` + + +### Parâmetros de geolocalização + +O Rest PKI Core pode capturar a localização geográfica do dispositivo do usuário durante a sessão de biometria. O recurso está **desabilitado por padrão**, essa é uma característica do software e pode ser habilitado por sessão, globalmente na configuração da subscription ou, em instâncias próprias (on-premises), diretamente no `appsettings` (seção `Bio`). + +> [!TIP] +> Prefere configurar o padrão pelo painel? Veja [Configuração de geolocalização](configs/geolocation.md). + +- **`GeolocationCaptureType`**: Define o comportamento da captura. + - **`Disabled`** (padrão): Geolocalização não é coletada. + - **`Optional`**: O sistema tenta capturar a geolocalização, mas a sessão prossegue normalmente caso o usuário negue permissão ou a captura falhe. + - **`Required`**: A geolocalização é obrigatória. A sessão é interrompida se a captura não for concluída com sucesso. + - **`BestEffort`**: O sistema tenta capturar a geolocalização sem nunca interromper a sessão. Falhas transitórias (ex.: timeout) são tentadas novamente automaticamente, por padrão até 3 vezes; falhas permanentes (ex.: permissão negada) não são reenviadas. Se todas as tentativas falharem, a sessão prossegue normalmente sem a localização. + +- **`GeolocationCapturePolicy`**: Define em quais dispositivos a geolocalização é coletada (relevante para sessões com QR code). + - **`CollectOnCaptureDevice`** (padrão): A geolocalização é capturada apenas no dispositivo que realiza a biometria (ex: o celular, nos fluxos com QR code). + - **`CollectOnAllDevices`**: A geolocalização é capturada em todos os dispositivos envolvidos na sessão — tanto no desktop que iniciou quanto no celular que realizou a captura. + +> [!NOTE] +> Quando `GeolocationCaptureType` é `BestEffort`, por padrão o usuário vê uma etapa pedindo a permissão de localização, porém sem os botões de cancelar ou pular — já que essa captura nunca pode interromper a sessão. Esse comportamento pode ser desativado pelo painel, removendo essa etapa própria do Rest PKI Core — veja [Configuração de geolocalização](configs/geolocation.md). Mesmo assim, o navegador pode exibir seu próprio pedido de permissão caso o usuário ainda não tenha decidido sobre ela (ver nota abaixo). + +> [!NOTE] +> A exibição (ou não) do pedido de permissão, e por quanto tempo o navegador lembra da permissão concedida, são definidos por cada navegador e fogem ao controle do Rest PKI Core. Em alguns navegadores, conceder a permissão de forma temporária (ex.: "Permitir desta vez" no Chrome) pode manter a localização disponível durante a sessão do navegador, mesmo quando a captura é opcional. Para detalhes sobre cada comportamento, consulte a documentação do respectivo navegador. + ## Tipos de sessão * [Prova de vida (`Liveness`)](liveness.md) diff --git a/docs.pt-br/articles/toc.md b/docs.pt-br/articles/toc.md index 8d294369..3d47b3c7 100644 --- a/docs.pt-br/articles/toc.md +++ b/docs.pt-br/articles/toc.md @@ -112,6 +112,9 @@ #### [Autenticação facial (Authentication)](rest-pki/core/integration/bio-sessions/authentication.md) #### [Identificação facial (Identification)](rest-pki/core/integration/bio-sessions/identification.md) #### [Captura de documento (IdentificationDocumentCapture)](rest-pki/core/integration/bio-sessions/id-capture.md) +#### Configurações +##### [Formatos de identificador](rest-pki/core/integration/bio-sessions/configs/subject-identifier-formats.md) +##### [Geolocalização](rest-pki/core/integration/bio-sessions/configs/geolocation.md) ### [Referenciando arquivos](rest-pki/core/integration/file-referencing.md) ### [Webhooks](rest-pki/core/integration/webhooks.md) ### [Códigos de erro](rest-pki/core/integration/error-codes.md) diff --git a/images/rest-pki/core/geolocation-best-effort.png b/images/rest-pki/core/geolocation-best-effort.png new file mode 100644 index 00000000..81ae7406 Binary files /dev/null and b/images/rest-pki/core/geolocation-best-effort.png differ diff --git a/images/rest-pki/core/geolocation-bio-settings.png b/images/rest-pki/core/geolocation-bio-settings.png new file mode 100644 index 00000000..30e35c64 Binary files /dev/null and b/images/rest-pki/core/geolocation-bio-settings.png differ diff --git a/images/rest-pki/core/geolocation-values.png b/images/rest-pki/core/geolocation-values.png new file mode 100644 index 00000000..8a5889ff Binary files /dev/null and b/images/rest-pki/core/geolocation-values.png differ