O objetivo deste manual é fornecer todas as informações necessárias para instalação e uso da ferramenta nos aplicativos desenvolvidos para plataforma React Native.

Este Plugin realiza a coleta de dados do dispositivo e envio para ClearSale. Todas as informações coletadas são dados relacionados apenas ao dispositivo, sem relação ao aplicativo integrado.

Este Plugin realiza a coleta de dados (informações e localização) do dispositivo e envio para ClearSale. Todas as informações coletadas são dados relacionados apenas ao dispositivo, sem relação ao aplicativo integrado.

A informação de geolocalização depende da permissão concedida pelo usuário do dispositivo, neste caso é necessário que o aplicativo solicite o acesso da informação de localização do usuário (o SDK não solicita permissão). Caso o aplicativo não solicite o acesso ou o usuário não conceda permissão, para localização, não será realizada a captura das informações de GeoLocation.

O Plugin respeita a política de privacidade da Apple e do Google para a captura dos dados do device e o nivel de permissão atribuído pelo usuário (usuário do dispositivo).

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-6VAoJWwE2O4R28Z30FtagJOu/jY=

Para consultar o checksum do artefato verifique o package.json.lock, após executar o comando npm install no seu projeto.

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-NjDR2LR86fxl7Wg5tJyt3CSN0MA=

Para consultar o checksum do artefato verifique o package.json.lock, após executar o comando npm install no seu projeto.

Checksum

Package	Digest
clear.sale/behavior-analytics-react-native-sdk	sha1-pbslw3vmGSAcokuH2X/1wTOZi8M=

Para consultar o checksum do artefato verifique o package.json.lock, após executar o comando npm install no seu projeto.

Dependências

- Node >= 10.19.0
- React Native >= 0.63.2

- Node >= 20.11.1
- React Native >= 0.73.4

React-Navigation (navegação entre telas)

- react-navigation/native: 5.7.3
- react-navigation/stack: 5.9.0

- react-navigation/native: 6.1.9
- react-navigation/stack: 6.9.17

npm install @clear.sale/behavior-analytics-react-native-sdk@2.5.3

yarn add @clear.sale/behavior-analytics-react-native-sdk@2.5.3

npm install @clear.sale/behavior-analytics-react-native-sdk@2.5.2

yarn add @clear.sale/behavior-analytics-react-native-sdk@2.5.2

@clear.sale:registry=https://pkgs.dev.azure.com/CS-PublicPackages/Behavior/_packaging/BehaviorAnalytics.SDK/npm/registry

    always-auth=true

    

"dependencies": {
        "@clear.sale/behavior-analytics-react-native-sdk": "1.0.1-rc.2",
        ...
    },
    

npm install @clear.sale/behavior-analytics-react-native-sdk@1.0.1-rc.2

Interface Behavior

Disponibiliza todos os métodos que realizam a comunicação com o SDK, todos métodos retornam uma Promise.

Métodos

Nome do método	Plataforma	Descrição
Promise<String> generateSessionId(appKey)	Android / iOS	Gera e retorna um identificador de sessão. Este método deve ser utilizado somente se o aplicativo não gerar identificadores únicos para cada coleta.
Promise<void> collectDeviceInformation(appKey, sessionId)	Android / iOS	Realiza a coleta das informações do dispositivo vinculando ao valor de Sessão. É necessário passar como parâmetro o SessionId, valor de sessão. Observações: Caso não possua um valor próprio para o SessionId utilizar o método. generateSessionId(). O tamanho máximo de SessionId a ser usado é 128 caracteres. O tamanho mínimo do SessionId a ser usado é de 6 caracteres.
Promise<void> start(appKey, success, failure)	Android	Inicia a coleta das informações sobre o dispositivo e a tela, Exception: CaptureWasStartedException - lançada quando uma captura anterior não foi parada.
Promise<void> stop(appKey, sessionId, success, failure)	Android	Encerra o processo de captura dos dados.
Promise<void> allowAppList()	Android	Ativa a coleta de informações sobre os aplicativos instalados no dispositivo.
Promise<void> allowGeoLocation()	Android	Ativa a coleta de geolocalização.

Exemplos

Exemplo de uso do plugin.

Importando o plugin

import ClearSaleModule from 'behavior-analytics-react-native-sdk'
                            

Utilizando os métodos start e stop durante o ciclo de vida do componente (React Hooks):

useEffect(() => {
    if (Platform.OS === 'android') {
        ...
        ClearSaleModule.start(appKey)
        ClearSaleModule.allowAppList()
        ClearSaleModule.allowGeoLocation()

        return () => {
            ...
            ClearSaleModule.stop(appKey)
        }
    }
}, [])
                            

useEffect(() => {
    if (Platform.OS === 'android') {
        ...
        ClearSaleModule.start(appKey)
        ClearSaleModule.allowAppList()

        return () => {
            ...
            ClearSaleModule.stop(appKey)
        }
    }
}, [])
                            

Android

Para utilizar as funções generateSessionId e collectDeviceInformation é necessário que o método start tenha sido executado.

Caso o método start seja executado sem que o método stop ocorra, será lançada uma exception do tipo CaptureWasStartedException.

Método de coleta de dados

Método generateSessionId retorna o sessionId.

const loadPage = async () => {
    ...

    await verifyLocationPermissions()

    const sessionId = await ClearSaleModule.generateSessionId(state.token)
    setState({
        ...state,
        sessionId: sessionId
    })

    ...
}
                            

Método collectDeviceInformation inicia coleta de dados com um sessionId já existente.

useFocusEffect(
    React.useCallback(() => {
        loadPage()

    return () => {
        unloadPage()
        };
    }, [])
);

const loadPage = async () => {
    ClearSaleModule.collectDeviceInformation(state.token, state.sessionId).then(() => {
        console.log('id com sucesso', state.sessionId)
        setLoading(false)
        setSend(true)
    }).catch(() => {
        setLoading(false)
        setSend(false)
    })
}
                            

Capturando a resposta da Promise.

const getSessionId = () => {
    ClearSaleModule.generateSessionId(appKey).then(sessionId => {
        ...
        setSessionId(sessionId)
    }).catch(err => {
        ...
    })
}
                            

Projeto de Exemplo

É possível visualizar a implementação do SDK em um projeto de exemplo Clicando aqui.

Remoção

Npm:

npm uninstall @clear.sale/behavior-analytics-react-native-sdk

npm uninstall @clear.sale/behavior-analytics-react-native-sdk

Yarn:

yarn remove @clear.sale/behavior-analytics-react-native-sdk

yarn remove @clear.sale/behavior-analytics-react-native-sdk

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 :

• Localização precisa (quando habilitada permissão pelo usuário);
• Identificadores de publicidade do dispositivo (quando habilitada permissão pelo usuário);
• Características físicas do dispositivo/ hardware (Como tela, bateria, teclado, espaço livre em disco, modelo, nome do dispositivo);
• Características de software (Como versão, idioma, build, controle parental);
• Informações de rede (Como Conexões, IP);
• Operadora do SimCard.

Política de privacidade da Google
Política de privacidade da Apple

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 :

• Identificadores de publicidade do dispositivo (quando habilitada permissão pelo usuário);
• Características físicas do dispositivo/ hardware (Como tela, bateria, teclado, espaço livre em disco, modelo, nome do dispositivo);
• Características de software (Como versão, idioma, build, controle parental);
• Informações de rede (Como Conexões, IP);
• Operadora do SimCard.

Política de privacidade da Google
Política de privacidade da Apple