屏蔽字库接入说明

1. 接入必读

该文档主要负责提供平台字库数据;
有关英文单词或者缩写、网址类的屏蔽词,区分大小写,使用时需要注意!
接入前需要先联系运营团队,获取自己产品的字库获取地址;
注意:该接口返回字库列表需要游戏研发进行缓存,建议每30分钟更新一次;

2. 接口说明

  • 接口协议:HTTP GET;
  • 交互数据格式:JSON格式(以UTF-8进行编码);

    3. 接口

3.1 字库数据获取接口

  • 3.1.1 接口地址
    接口地址请联系运营团队,从平台上获取产品的接口地址(注意每个产品不同);

  • 3.1.2 网络安全
    为了保证数据安全性,该接口需要校验游戏服的IP地址;接入前需要把IP地址提交给运营团队进行配置;

  • 3.1.3 请求参数
    根据获取到的接口地址进行请求,地址需要追加checksum参数,用以校验字库数据是否变化;
    checksum:取值于上次请求结果中的checksum字段值;
    首次访问时checksum08c0372780bcbd1eb73ceca2f03f319b

  • 3.1.4 返回参数

参数名称 类型 说明
status 字符串 状态码,0成功,1失败
reset 字符串 详细状态码;详见详细状态码表
updateTime 字符串 策略最后更新时间
desc 字符串 描述
checksum 字符串 校验码,用于下次请求携带
keyList 字符串 返回的关键字数据;注意当请求地址中的checksum和返回的checksum相同时,keyList返回null;标识字库数据无变化;
  • 3.1.5 请求示例

    1. http://gscservice.gamebean.net/gscproxy/s/100301.htm?pid=10000538&sid=1001&checksum=08c0372780bcbd1eb73ceca2f03f319b
  • 3.1.6 返回示例

    1. {
    2. "status":"0",
    3. "reset":"1000",
    4. "desc":"",
    5. "updateTime":"2017-04-21 15:13:39",
    6. "keyList":[
    7. "&",
    8. "eter",
    9. "ae21tz",
    10. "你好",
    11. "d24dff",
    12. "Eter",
    13. "是否",
    14. "D24dff",
    15. "jr343gh"
    16. ],
    17. "checksum":"4a32d1284b817afa296419045e81e542"
    18. }

附录1

详细状态码表

详细状态码 状态描述
1000 成功
9999 ip签权失败
g240 产品未配置该字库服务
g241 IP未授权
g242 该策略已经暂停服务
g243 该产品不允许访问该服务