QitechDeviceScan 对象

重要提示！

自 1.0.0 版本起，认证方式已更新为使用临时 token 替代 mobileToken。该 token 通过向 Device Scan API 发起服务器到服务器请求获取。

调用

要使用 Device Scan 插件，需要调用 startDeviceScan 方法，该方法具有以下参数：

1.0.0 及以上版本

参数	类型	功能	必需
token	String	向 Device Scan API 发起请求获取的临时认证 token。必须使用与本方法相同的 sessionId 生成。	是。
environment	CaaSEnvironment	用于将执行环境配置为 sandbox 或 production 的枚举值。	是。
sessionId	String	标识所收集数据所属会话的密钥。必须使用小写字母发送。	是。
eventType	String	定义正在报告的事件类型的枚举值——建议注意，非常相似的事件应使用相同的枚举值进行报告，以便可以基于这些数据构建智能。	是。
eventId	String	正在报告的事件的标识符。	是。
documentNumber	String?	用户的证件号码（如果可用）。（CPF/CNPJ，不含点、连字符和斜杠）。可以省略。	否。

早期版本（0.x 及以下）

参数	类型	功能	必需
mobileToken	String	标识所收集数据来自您的应用程序的客户端密钥。如果您尚未收到 mobile-token，请联系支持团队。	是。
environment	CaaSEnvironment	用于将执行环境配置为 sandbox 或 production 的枚举值。	是。
sessionId	String	标识所收集数据所属会话的密钥。必须使用小写字母发送。	是。
eventType	String	定义正在报告的事件类型的枚举值。	是。
eventId	String	正在报告的事件的标识符。	是。
documentNumber	String?	用户的证件号码（如果可用）。	否。

快速迁移摘要

• 1.0.0 及以上：使用通过 API 获取的临时 token（token: token）
• 低于 1.0.0：使用静态 mobileToken（mobileToken: '<MOBILE_TOKEN_SENT_BY_QITECH>'）
• 两者中 environment、sessionId、eventType 和 eventId 均为必填，documentNumber 为可选。

迁移到 2.0.0

• pubspec.yaml：qitech_device_scan: ^2.0.0。Dart 代码无需改动。
• iOS：在 Podfile 中加入 source 'https://github.com/QITechSDKs/iOS.git'。原生 SDK 开始要求 Datadog 3.x（如使用 datadog_flutter_plugin，请用 3.x）。
• Android：在 build.gradle 中加入 Maven 仓库 https://sdks.qitech.com.br/。

返回值

该方法返回一个字符串，表示信息收集期间的成功或失败：

成功

Success collecting device scan data

错误

Device Scan fail. Check token, environment and permissions