接入说明

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

DPAPI

Deepknow 主要外部调用接口类

Method

getInstance(Context, String)

初始化 DPAPI 类,且设置 APP_ID

Declaration

public static DPAPI getInstance(Context context, String app_id)

Parameters

Param Type Description
context Context 上下文
app_id String 产品的 app_id

Discussion

务必在 Application 中初始化,且设置 app_id

getInstance(Context)

获取 DPAPI 单例对象

Declaration

public static DPAPI getInstance(Context context)

Parameters

Param Type Description
context Context 上下文

Discussion

获取已初始化的 DPAPI 对象,执行获取 session 等额外操作

sdkVersion()

获取 SDK 版本号

Declaration

public static String sdkVersion()

getSessionStatus(DPListener)

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

Declaration

public void getSessionStatus(DPListener listener)

Discussion

设置 DPListener 对象监听获取数据

submitExtraData(JSONObject, DPListener)

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

Declaration

public void submitExtraData(JSONObject json, DPListener callBack)

Parameters

Param Type Description
json JSONObject 待提交的自定义数据
callBack DPListener 提交结果回调

Discussion

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

setLogEnable(boolean)

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

Declaration

public DPAPI setLogEnable(boolean openDebug)

Discussion

务必在初始化时设置

closeSQL()

关闭数据库连接

Declaration

public DPAPI closeSQL()

Discussion

务必在应用退出时执行

DPListener

session 回调监听类

Method

onSessionResult(JSONObject)

回调 session 对象,Json 数据格式

Declaration

public void onSessionResult(JSONObject json)

Parameters

Param Type Description
json JSONObject 返回的 session 对象,json 格式标识

Discussion

json 示例

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

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

onSessionStatus(boolean)

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

Declaration

public void onSessionStatus(boolean status)

Parameters

Param Type Description
status boolean true 为及时返回,false 为异步返回

Discussion

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