liveness_flutter_sdk 2.0.0 liveness_flutter_sdk: ^2.0.0 copied to clipboard
ClearSale Liveness Flutter SDK
liveness_flutter_sdk #
CSLiveness Flutter
Instalação #
flutter pub add liveness_flutter_sdk
Android
Adicione um arquivo clearsale.gradle.env
na raiz do seu projeto flutter.
Esse arquivo deve conter as seguintes propriedades:
CS_LIVENESS_TEC_ARTIFACTS_FEED_URL=ARTIFACTS_FEED_URL // valor fornecido pela clear sale
CS_LIVENESS_TEC_ARTIFACTS_FEED_NAME=ARTIFACTS_FEED_NAME // valor fornecido pela clear sale
CS_LIVENESS_TEC_USER=USERNAME // valor fornecido pela clear sale
CS_LIVENESS_TEC_PASS=ACCESSTOKEN // valor fornecido pela clear sale
CS_LIVENESS_VERSION=LAST_VERSION // valor fornecido pela clear sale
iOS #
No arquivo Podfile
de seu projeto adicione o seguinte código:
platform :ios, '12.0'
use_frameworks!
target 'NOME_DO_SEU_PROJETO' do
pod 'CSLivenessSDK', :git => 'https://CS-Packages:YOUR_PAT_HERE@dev.azure.com/CS-Package/ID-Lab-PackagesSDK/_git/CSLivenessSDK', :tag => 'VERSION_HERE'
end
Instruções de uso #
Importe o plugin no seu projeto e use o método openCSLiveness
que irá chamar a SDK nativa do dispositivo.
O resultado da função open
é um future
que pode retornar os seguintes valores:
class CSLivenessResult {
final bool real;
final String sessionId;
final String image;
final String? responseMessage;
}
Caso o future
seja rejeitado, ela retorna o erro que causou a rejeição (CSLivenessResult no Android
, CSLivenessError no iOS
e UserCancel
).
Exemplo de uso #
// Platform messages are asynchronous, so we initialize in an async method.
Future<void> callCSLivenessSDK(
String accessToken,
String transactionId,
bool vocalGuidance,
Color primaryColor,
Color secondaryColor,
Color titleColor,
Color paragraphColor) async {
// Platform messages may fail, so we use a try/catch PlatformException.
// We also handle the message potentially returning null.
String result;
try {
var sdkResponse =
await _livenessFlutterSdkPlugin.openCSLiveness(
accessToken,
transactionId,
vocalGuidance,
primaryColor,
secondaryColor,
titleColor,
paragraphColor);
result = jsonEncode(sdkResponse);
} on PlatformException catch (e) {
result = "Error: $e";
} catch (e) {
result = "Error: $e";
}
// If the widget was removed from the tree while the asynchronous platform
// message was in flight, we want to discard the reply rather than calling
// setState to update our non-existent appearance.
if (!mounted) return;
setState(() {
_result = result;
});
}
Como obter o accessToken e transactionId? #
accessToken
: Faça a autenticação seguindo as instruções da API DataTrust e obtenha otoken
do retorno.transactionId
: Crie uma transação seguindo as instruções da API DataTrust e obtenha oid
do retorno.
Executando o aplicativo de exemplo #
- Conecte um dispositivo físico (
Android
ouiOS
- o nossoSDK
não roda em emuladores, apenas em dispositivos fisícos) à sua máquina de desenvolvimento. - Clone esse repositório e rode
flutter pub get
. - Coloque suas credenciais no arquivo
clearsale.gradle.env
na raiz do projeto de exemplo e adicione também as credenciais no arquivoexample/ios/Podfile
. - Inicie o app
- Ao pressionar o botão
Open CSLiveness
o SDK DocumentosCopy iniciará. Após completar o fluxo o aplicativo retorna odocumentType
esessionId
.
Detalhes de privacidade #
Uso de dados
Todas as informações coletadas pelo SDK da ClearSale são com exclusiva finalidade de prevenção à fraude e proteção ao próprio usuário, aderente à política de segurança e privacidade das plataformas Google e Apple e à LGPD. Por isso, estas informações devem constar na política de privacidade do aplicativo.
Tipo de dados coletados
O SDK da ClearSale coleta as seguintes informações do dispositivo :
Características físicas do dispositivo/ hardware (Como tela, modelo, nome do dispositivo); Características de software (Como versão, idioma, build, controle parental); Informações da câmera; Licença de Uso Ao realizar o download e utilizar nosso SDK você estará concordando com a seguinte licença:
Copyright © 2022 ClearSale
Todos os direitos são reservados, sendo concedida a permissão para usar o software da maneira como está, não sendo permitido qualquer modificação ou cópia para qualquer fim. O Software é licenciado com suas atuais configurações “tal como está” e sem garantia de qualquer espécie, nem expressa e nem implícita, incluindo mas não se limitando, garantias de comercialização, adequação para fins particulares e não violação de direitos patenteados. Em nenhuma hipótese os titulares dos Direitos Autorais podem ser responsabilizados por danos, perdas, causas de ação, quer seja por contrato ou ato ilícito, ou outra ação tortuosa advinda do uso do Software ou outras ações relacionadas com este Software sem prévia autorização escrita do detentor dos direitos autorais.