接入说明

deepkonw 为极验业务安全服务的基础感知构件，主要用于采集客户端的相关安全信息，为后续服务提供数据，是其他极验服务的基础

DPAPI

Deepknow 主要外部调用接口类

Method

getInstance(context: Context, appId?: string)

初始化 DPAPI 类，且设置 APP_ID

Declaration

static getInstance(context: Context, appId?: string): DPAPI | null

Parameters

Discussion

初始化DPAPI 对象，且设置 app_id。后续执行获取 session 等额外操作时，获取已初始化的 DPAPI 对象不用再传app_id

sdkVersion()

获取 SDK 版本号

Declaration

public static sdkVersion(): string

getSessionStatus(listener: DPListener)

获取 Session 对象，通过回调接口获取

Declaration

getSessionStatus(listener: DPListener): void

Discussion

设置 DPListener 对象监听获取数据

submitExtraData(json: Record<string, Object>, callBack: DPListener)

提交自定义数据给极验分析

Declaration

submitExtraData(json: Record<string, Object>, callBack: DPListener): void

Parameters

Discussion

待提交的数据必须包含 “scene” 字段(第一层)，标识场景，具体见服务端文档说明

setLogEnable(openDebug: boolean)

设置是否查看日志，上线务必关闭日志

Declaration

setLogEnable(openDebug: boolean): DPAPI

Discussion

务必在初始化时设置

DPListener

session 回调监听类

Method

onSessionResult: (jsonObject: Record<string, Object>|null)

回调 session 对象，Json 数据格式

Declaration

onSessionResult: (jsonObject: Record<string, Object>|null) => void

Parameters

Discussion

json 示例

{
    "status":1,
    "message":"ok",
    "session_id":"dec6ba16-01d3-4a83-b063-bcaf87c7d3bd"
}

status 1 为成功，其余为失败，若失败 session_id 为 “”或缺省，message 为错误描述。

onSessionStatus: (status: boolean)

session 回调状态，true 为及时返回，false 为异步返回

Declaration

onSessionStatus: (status: boolean) => void

Parameters

Discussion

若为 false 代表此时异步请求服务器获取 session，因为有延迟，建议此时 show loading 操作