O objeto QitechDeviceScan

Aviso Importante!

A partir da versão 1.0.0, o sistema de autenticação foi atualizado para usar um token temporário no lugar do mobileToken. O token é obtido por meio de requisição server-to-server à API da Device Scan.

Chamada

Para utilizar o plugin de Device Scan, é necessário realizar a chamada do método startDeviceScan que possui os seguintes parâmetros:

Versão 1.0.0+

Parâmetro	Tipo	Função	Obrigatório
token	String	Token de autenticação temporário obtido por meio de requisição à API da Device Scan. Deve ser gerado com o mesmo sessionId passado a este método.	Sim.
environment	CaaSEnvironment	Enumerador utilizado para configurar o ambiente de execução para sandbox ou production.	Sim.
sessionId	String	Chave que identifica a sessão da qual os dados coletados são provenientes. Deve ser enviado em letras minúsculas.	Sim.
eventType	String	Um enumerador que define o tipo de evento sendo reportado - É pedido cuidado para que eventos muito similares seja reportados com o mesmo enumerador, a fim de que inteligência possa ser construída sobre esses dados.	Sim.
eventId	String	Um identificador do evento sendo reportado	Sim.
documentNumber	String?	O número do documento do usuário, caso disponível. (CPF/ CNPJ sem pontos, traços e barra). Pode ser omitido.	Não.

Versões Anteriores (até 0.x)

Parâmetro	Tipo	Função	Obrigatório
mobileToken	String	Chave do cliente que identifica que os dados coletados são provenientes do seu aplicativo. Caso ainda não tenha recebido o seu mobile-token, entre em contato com o suporte.	Sim.
environment	CaaSEnvironment	Enumerador utilizado para configurar o ambiente de execução para sandbox ou production.	Sim.
sessionId	String	Chave que identifica a sessão da qual os dados coletados são provenientes. Deve ser enviado em letras minúsculas.	Sim.
eventType	String	Um enumerador que define o tipo de evento sendo reportado - É pedido cuidado para que eventos muito similares seja reportados com o mesmo enumerador, a fim de que inteligência possa ser construída sobre esses dados.	Sim.
eventId	String	Um identificador do evento sendo reportado	Sim.
documentNumber	String?	O número do documento do usuário, caso disponível. (CPF/ CNPJ sem pontos, traços e barra). Pode ser omitido.	Não.

Resumo Rápido (Migração)

• 1.0.0+: usar token temporário obtido via API (token: token)
• < 1.0.0: usar mobileToken estático (mobileToken: '<MOBILE_TOKEN_SENT_BY_QITECH>')
• Em ambas: environment, sessionId, eventType e eventId são obrigatórios. documentNumber é opcional.

Retorno

O método retorna uma String para indicar sucesso ou falha durante a coleta das informações:

Sucesso

Success collecting device scan data

Erro

Device Scan fail. Check token, environment and permissions