Guia de uso e integração
Apresenta as informações necessárias para uso e integração do SDK Oiti em seus aplicativos iOS.
Siga as instruções detalhadas e aproveite os recursos avançados oferecidos por esta ferramenta para melhorar a segurança e a precisão da autenticação biométrica e verificação de documentos.
Appkey em fluxos com Liveness 2D/3D + Doc Core
Cada appkey está associada a uma transação específica ou tem um prazo de expiração definido. Em fluxos que tenham apenas Liveness, a appkey não deve ser reutilizada.
Exceção: para os fluxos de trabalho que incluem Liveness 2D ou 3D e têm a etapa de Doc Core como próxima etapa, a appkey será reutilizada para realizar a análise do documento.
Ambiente
Todos os módulos do SDK possuem o parâmetro de environment que indica o ambiente de execução desejado, esse parâmetro recebe um objeto do tipo
Environment
que possui dois valores:
Valor Descrição HML Aponta para o ambiente de homologação. PRD Aponta para o ambiente de produção.
Liveness 3D
Passo 1: Importação do módulo
Importe o OILiveness3D no arquivo onde será utilizada:
import OILiveness3D
Passo 2: Configuração do Liveness3DUser
Crie um objeto do tipo Liveness3DUser
passando para esse objeto os seguintes parâmetros:
Parâmetro | Descrição |
---|---|
appkey | Chave gerada para execução dessa etapa. |
ticket | Token para uso da Certiface API. |
environment | Ambiente de execução desejado. Possui o valor HML como padrão. |
defaultTheme | Objeto contendo a customização padrão do processo de autenticação biométrica. |
lowLightTheme | Objeto contendo a customização do processo de autenticação biométrica, quando o SDK reconhecer um ambiente com baixa luminosidade. |
texts | Dicionário contendo os textos que serão alterados no processo de autenticação biométrica. |
Nota
- O parâmetro
ticket
é opcional;- Os parâmetros
defaultTheme
,lowLightTheme
etexts
são opcionais e estão relacionados a customização.
let liveness3DUser = Liveness3DUser(
appKey: "APP-KEY",
ticket: "TICKET",
environment: .HML
)
Passo 3: Configuração do Liveness3DViewController
Crie uma instância para a classe Liveness3DViewController
passando os seguintes parâmetros:
Parâmetro | Descrição |
---|---|
liveness3DUser | Objeto com as informações necessárias para execução do Liveness 3D. |
delegate | Objeto responsável por implementar os métodos que tratam o resultado do Liveness3D. |
customInstructionView | Objeto contendo a customização da tela de instruções. |
customPermissionView | Objeto contendo a customização da tela de permissão de câmera. |
let controller = Liveness3DViewController(
liveness3DUser: liveness3DUser,
delegate: self
)
Notas
- Os parâmetros
customInstructionView
ecustomPermissionView
são opcionais e estão relacionados a customização;- O objeto
liveness3DUser
é o mesmo criado no passo 2.
Passo 4: Implementação do delegate
Implemente o protocolo Liveness3DDelegate
que possui os seguintes métodos:
Método | Descrição |
---|---|
handleLiveness3DValidation(validateModel:) | Método chamado após ser efetuada a autenticação biométrica. |
handleLiveness3DError(error:) | Método chamado caso ocorra algum problema durante a autenticação biométrica. |
Passo 5: Apresentação da controller
Apresente a controller instanciada anteriormente como uma modal:
controller.modalPresentationStyle = .fullScreen
present(liveness3DViewController, animated: true)
Nota
O objeto
controller
é o mesmo criado no passo 3.
Exemplo do código completo:
import OILiveness3D
import UIKit
class ViewController: UIViewController {
func openLivenes3DPressed() {
let liveness3DUser = Liveness3DUser(
appKey: "APP-KEY",
ticket: "TICKET",
environment: .HML
)
let controller = Liveness3DViewController(
liveness3DUser: liveness3DUser,
delegate: self
)
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)
}
}
extension ViewController: Liveness3DDelegate {
func handleLiveness3DValidation(validateModel: Liveness3DSuccess) {
// Seu código ...
}
func handleLiveness3DError(error: Liveness3DError) {
// Seu código ...
}
}
Liveness 2D
Passo 1: Importação do módulo
Importe o OILiveness2D no arquivo onde será utilizada:
import OILiveness2D
Passo 2: Configuração do FaceCaptchaViewController
Crie uma instância para a classe FaceCaptchaViewController
passando os seguintes parâmetros:
Parâmetro | Descrição |
---|---|
appKey | Chave gerada para execução dessa etapa. |
environment | Ambiente de execução desejado. |
delegate | Objeto responsável por implementar os métodos que tratam o resultado do Liveness 2D. |
showFeedback | Valor booleano que indica se a tela de resultado deve ser apresentada ou não. |
customInstructionsView | Objeto contendo a customização da tela de instruções. |
customLivenessView | Objeto contendo a customização da tela de prova de vida. |
customProcessResultView | Objeto contendo a customização da tela de processamento dos resultados. |
customResultView | Objeto contendo a customização da tela de resultado do processamento. |
customCameraPermissionView | Objeto contendo a customização da tela de permissão de câmera. |
Nota
- O parâmetro
showFeedback
é opcional e possui true como valor padrão;- Os parâmetros
customInstructionsView
,customLivenessView
,customProcessResultView
,customResultView
ecustomCameraPermissionView
são opcionais e estão relacionados a customização.
let controller = FaceCaptchaViewController(
appKey: "APP-KEY",
environment: .HML,
delegate: self
)
Passo 3: Apresentação da controller
Apresente a controller instanciada anteriormente como uma modal:
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)
Nota
O objeto
controller
é o mesmo criado no passo 2.
Passo 4: Implementação do delegate
Implemente o protocolo FaceCaptchaDelegate
que possui os seguintes métodos:
Método | Descrição |
---|---|
handleSuccess(model:) | Método chamado após ser efetuada a autenticação biométrica. |
handleError(error:) | Método chamado caso o ocorra algum problema durante a autenticação biométrica. |
handleCanceled() | Método chamado caso o usuário cancele o processo de autenticação biométrica. |
Exemplo do código completo:
import OILiveness2D
import UIKit
class ViewController: UIViewController {
func openFaceCaptchaPressed() {
let controller = FaceCaptchaViewController(
appKey: "APP-KEY",
environment: .HML,
delegate: self
)
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)
}
}
extension ViewController: FaceCaptchaDelegate {
func handleSuccess(model: FaceCaptchaSuccessModel) {
// Seu código ...
}
func handleError(error: FaceCaptchaError) {
// Seu código ...
}
func handleCanceled() {
// Seu código ...
}
}
Doc Core
Passo 1: Importação do módulo
Importe o OILiveness2D no arquivo onde será utilizada:
import OILiveness2D
Passo 2: Configuração do DocumentscopyViewController
Crie uma instância para a classe DocumentscopyViewController
passando os seguintes parâmetros:
Parâmetros | Descrição |
---|---|
ticket | Token para uso da Certiface API. |
appKey | Chave gerada para execução dessa etapa. |
environment | Ambiente de execução desejado. |
delegate | Objeto responsável por implementar os métodos que tratam o resultado da Documentoscopia. |
showFeedback | Valor booleano que indica se a tela de resultado deve ser apresentada ou não. |
customInstructionView | Objeto contendo a customização da tela de instruções. |
customView | Objeto contendo a customização da tela de captura de documento. |
customLoadingView | Objeto contendo a customização da tela de carregamento do resultado. |
customResultView | Objeto contendo a customização da tela de resultado. |
customCameraPermissionView | Objeto contendo a customização da tela de permissão de câmera. |
Nota
- O parâmetro
ticket
é opcional;- O parâmetro
showFeedback
é opcional e possui true como valor padrão;- Os parâmetros
customInstructionView
,customView
,customCameraPermissionView
,customLoadingView
ecustomResultView
são opcionais e estão relacionados a customização.
let controller = DocumentscopyViewController(
ticket: "TICKET",
appKey: "APP-KEY",
environment: .HML,
delegate: self
)
Passo 3: Apresentação da controller
Apresente a controller instanciada anteriormente como uma modal:
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)
Nota
O objeto
controller
é o mesmo criado no passo 2.
Passo 4: Implementação do delegate
Implemente o protocolo DocumentscopyDelegate
que possui os seguintes métodos:
Método | Descrição |
---|---|
handleDocumentscopyCompleted() | Método chamado após ser efetuada a verificação de documento. |
handleDocumentscopyError(error:) | Método chamado caso o ocorra algum problema durante a verificação de documento. |
handleDocumentscopyCanceled() | Método chamado caso o usuário cancele o processo de verificação de documento. |
Exemplo do código completo:
import OILiveness2D
import UIKit
class ViewController: UIViewController {
func openDocumentscopyPressed() {
let controller = DocumentscopyViewController(
ticket: "TICKET",
appKey: "APP-KEY",
environment: .HML,
delegate: self
)
controller.modalPresentationStyle = .fullScreen
present(controller, animated: true)
}
}
extension ViewController: DocumentscopyDelegate {
func handleDocumentscopyCompleted() {
// Seu código ...
}
func handleDocumentscopyError(error: DocumentscopyError) {
// Seu código ...
}
func handleDocumentscopyCanceled() {
// Seu código ...
}
}
Updated 4 months ago