Introdução

Os SDKs de Captura de Documentos permitem a realização de capturas pelo usuário dentro de sua aplicação. Essas capturas passam por validações que identificam o tipo de documento e que avaliam a qualidade da imagem capturada, instruindo o usuário através de feedbacks visuais.

Todas as informações coletadas são dados relacionados apenas ao dispositivo do usuário.

É necessário que o usuário conceda permissão de acesso à câmera do dispositivo para capturar e enviar seu documento.

iOS

Requisitos

• Versão do sistema operacional iOS: 12.0 ou superior.
• Versão do projeto Swift 4.2+: funciona com Xcode superior ao 14.
• Espaço em disco: 18.5mb

Instalação do Pacote

• CocoaPods

Para adicionar o SDK ao seu projeto utilizando Cocoapods basta adicionar o seguinte comando ao seu Podfile:

Instalação em ambiente de desenvolvimento e testes

platform :ios, '12.0'

use_frameworks!

target 'NOME_DO_SEU_PROJETO' do
pod 'CSDocumentoscopySDK', :git => 'URL DO REPOSITÓRIO ENVIADO PELA CLEARSALE', :tag => '2.1.2-hml'
end

Instalação em ambiente de produção

platform :ios, '12.0'

use_frameworks!

target 'NOME_DO_SEU_PROJETO' do
pod 'CSDocumentoscopySDK', :git => 'URL DO REPOSITÓRIO ENVIADO PELA CLEARSALE', :tag => '2.1.2'
end

Configuração

Instruções para configuração do framework no projeto:

1. Adicionar as seguintes entradas ao arquivo Info.plist do projeto de destino:

<key>NSCameraUsageDescription</key>
<string>This app requires access to the camera.</string>

Classe CSDocumentoscopySDK

Descrição
CSDocumentoscopy classe responsável pela inicialização do SDK.

Classe CSDocumentoscopySDKConfig

Descrição
CSDocumentoscopyConfig classe responsável por receber as configurações personalizadas do SDK.

Classe CSDocumentoscopyColorsConfig

Descrição
CSDocumentoscopyColorsConfig classe responsável por receber as configurações personalizadas de cores SDK.

Método initialize

Descrição
initialize é responsável pela inicialização do SDK e necessita de certos parâmetros para que consiga realizar sua tarefa.

Classe CSDocumentoscopyDelegate

Descrição
Para acesso à resposta do processamento da ClearSale ou erros durante o processo é disponibilizado o delegate CSDocumentoscopyDelegate.

Construtores
Esta classe não possui um construtor público.

Eventos do Fluxo

Eventos de Sucesso

Eventos de Erro

Classe CSDocumentoscopyError

Parâmetros
Esta classe possui os seguintes parâmetros.

Enum CSDocumentoscopyError

Descrição
Representa os possíveis erros que serão retornados pelo CSDocumentoscopyError

Cases
Este enum possui os seguintes cases:

Classe CSDocumentoscopySDKResult

Parâmetros
Esta classe possui os seguintes parâmetros.

Exemplos

Faça a importação da biblioteca em sua classe.

import CSDocumentoscopySDK

Instancie o SDK passando os parâmetros pedidos, conforme exemplo abaixo.

let sdk = CSDocumentoscopy()
sdk.delegate = self
sdk.initialize(
    clientId: "PARÂMETRO ENVIADO PELA CLEARSALE",
    clientSecret: "PARÂMETRO ENVIADO PELA CLEARSALE",
    identifierId: "PARÂMETRO GERADO PELO CLIENTE",
    cpf: "CPF DO USUÁRIO",
    viewController: "CONTEXTO QUE O SDK SERÁ ABERTO")

Implementação do Delegate
Estenda o protocolo CSDocumentoscopyDelegate e implemente seus métodos, para receber os retornos do SDK, como no exemplo abaixo.

extension Classe: CSDocumentoscopyDelegate {
    func didOpen() { }
    func didTapClose() { }
    func didFinishCapture(result: CSDocumentoscopyResult) { }
    func didReceiveError(error: CSDocumentoscopyError) { }
}

Samples

Visando facilitar a integração e homologação, disponibilizamos amostras dos SDK:

📘

Aplicativo de Exemplo em Objective-C: clique aqui

📘

Aplicativo de Exemplo em Swift: clique aqui