配置下发接口

2024.05.08 14:16:41

    接口说明

    当客户端风控SDK接口被恶意屏蔽时,易盾风控SDK无法获取配置信息(如初始化功能配置、特征配置等)进而无法正常工作,此时可在服务端通过此接口获取业务配置信息,并下发到客户端SDK完成配置,详情可参考客户端接入文档。当前版本为V5,老版本参考配置下发接口V4

    鉴权说明

    易盾智能风控服务使用签名认证方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5签名算法,详细信息请参见接口鉴权

    接入须知

    • 请控制接口调用频率,频率过高,可能会超过频率限制,导致查询失败(建议1个玩家最快3分钟请求1次)。

     

    请求说明

    请求地址

    名称
    HTTP URL http://ir-open.dun.163.com/v5/risk/getConfig
    HTTP Method POST

    请求头

    名称 类型 必填 描述
    Content-Type String 固定值:"Content-Type:application/json"

     

    请求参数

    请求参数分为:公共参数,接口参数。其中,公共参数请见公共请求参数;接口参数如下:

    参数 类型 必填 描述
    ip String 用户/ 玩家的IP,或当前客户端业务事件发生时的公网IP地址(ipv4)
    sdkData String 风控SDK返回的配置拉取凭证,详情见客户端接入文档

     

    请求参数示例

    {
        "businessId": "xxx966f73yyy59440583zzz9bfcc79df",
        "secretId": "nnn966f73yyy59440583zzz9bfcc79dc",
        "timestamp": ${currentTime},
        "nonce": "mmm888f73yyy59440583zzz9bfcc79de",
        "version": "500",
        "signature": "lll888f73yyy59440583zzz9bfcc79da",
        "ip":  "1.1.1.1",
        "sdkData": "..."
    }
    
    
    

    响应

    响应结果

    响应数据格式为:JSON。

    响应头为:Content-Type:application/json,具体如下:

    参数 类型 描述
    code Integer 响应码,正常情况下为200,异常时,见 附录响应码定义
    msg String 响应码说明,正常情况下返回“ok”,异常时,见 附录响应码定义
    desc String 响应信息描述,非必返,常见错误情况下会返回错误说明或错误参考文档
    data JSONObject 返回数据,格式下表说明

    返回数据格式:

    参数 类型 说明
    configData String 配置参数加密数据,应用/游戏方可转交给风控 sdk 解析处理。

    响应结果示例

    • 获取结果正常时:
    {
        "code": 200,
        "msg": "ok!",
        "data": {
            "configData": "xxxxxxxx"
        },
        "ok":true
    }
    

    响应返回码

    响应返回码见:响应返回码

    接入示例代码

    服务端 SDK 接入

    推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引了解更多。

    Github Demo 地址

    该接口的使用方法可参考以下SDK demo:

    Online Chat Tel:95163223 Free trial