csliveness-react-native v2.0.0

csliveness-react-native

CSLiveness para React Native

Instalação

npm install csliveness-react-native

Android

Adicione um arquivo clearsale.gradle.env na raiz do seu projeto de react-native. Esse arquivo deve conter as seguintes propriedades:

CS_LIVENESS_TEC_ARTIFACTS_FEED_URL= // fornecido pela clearsale
CS_LIVENESS_TEC_ARTIFACTS_FEED_NAME= // fornecido pela clearsale
CS_LIVENESS_TEC_USER= // fornecido pela clearsale
CS_LIVENESS_TEC_PASS= // fornecido pela clearsale
CS_LIVENESS_VERSION= // fornecido pela clearsale

iOS

No arquivo Podfile de seu projeto adicione o seguinte código:

platform :ios, '15.0'

use_frameworks!

target 'NOME_DO_SEU_PROJETO' do
  pod 'CSLivenessSDK', :git => 'URL DO REPOSITÓRIO ENVIADO PELA CLEARSALE', :tag => 'VERSÃO AQUI'
end

Adicione também no sue Info.plist a seguinte entrada:

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

Instruções de uso

Importe o plugin no seu projeto e use o useCSLiveness hook para receber uma função open que irá chamar a SDK nativa do dispositivo.

O resultado da função open é uma promise que pode retornar os seguintes valores:

type CSLivenessResult = {
  real: boolean;
  responseMessage?: string; // Android only
  sessionId: string | null;
  image: string | null;
};

Atenção

A propriedade responseMessage é retornada somente no Android.

Em caso de erro, a promise sera rejeitada com o motivo do erro em ambas as plataformas.

Exemplo de uso

import { useCSLiveness } from 'csliveness-react-native';

const ReactComponent = () => {
  const [accessToken, setAccessToken] = React.useState<string>('');
  const [transactionId, setTransactionId] = React.useState<string>('');
  const { open: openCsLivenessSdk } = useCSLiveness();

  ...


  return <TouchableOpacity
    style={styles.button}
    onPress={async () => {
      try {
        const { real, responseMessage, sessionId, image } = await openCsLivenessSdk({
          transactionId,
          accessToken,
          vocalGuidance,
          primaryColor,
          secondaryColor,
          titleColor,
          paragraphColor,
        });

        console.log(`Received responseMessage: ${responseMessage}`);
        console.log(`Received sessionId: ${sessionId}`);
        console.log(`Received image: ${image}`);
      } catch (e) {
        console.error(e);
        Alert.alert(
          'SDKError',
          'Something went wrong, check you dev console',
          [{ text: 'OK' }]
        );
      }
    }}
  >
    <Text style={styles.buttonTitle}>Open CSLiveness</Text>
  </TouchableOpacity>
}

Como obter o accessToken e transactionId?

• accessToken: Faça a autenticação seguindo as instruções da API DataTrust e obtenha o token do retorno.
• transactionId: Crie uma transação seguindo as instruções da API DataTrust e obtenha o id do retorno.

Executando o aplicativo de exemplo

1. Conecte um dispositivo físico (Android ou iOS - o nosso SDK não roda em emuladores, apenas em dispositivos fisícos) à sua máquina de desenvolvimento.
2. Clone esse repositório e rode yarn. Como esse projeto usa yarn workspaces, deve-se usar o comando yarn para instalar as dependências.
3. Coloque suas credenciais no arquivo clearsale.gradle.env (crie ele e adicione as informações conforme descrito na etapa de instalação) na raiz do projeto de exemplo e adicione também as credenciais no arquivo example/ios/Podfile.
4. Rode yarn example start (no caso do iOS é necessário rodar pod install na pasta example/ios primeiro).

• Caso queira rodar com o Android Studio o app de Android, é só abrir a pasta example/android no Android Studio.
• Caso queira rodar com o XCode o app de iOS, é só abrir o CslivenessReactNativeExample.xcworkspace/ com o XCode.

5. Ao pressionar o botão Open CSLiveness o SDK Liveness iniciará. Após completar o fluxo o aplicativo retornara o responseMessage, image e sessionId.

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.

Made with create-react-native-library