目录

按键精灵插件文档



1. 护卫盾_取模块版本号

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取模块版本号 整数型 获取护卫盾模块版本号

参数列表

无参数


2. 护卫盾_取错误信息

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取错误信息 文本型 获取最后一次出错信息.如未出错,将返回空

参数列表

无参数


3. 护卫盾_取错误码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取错误码 整数型 获取最后一次出错错误码.如未出错,将返回200

参数列表

无参数


4. 护卫盾_初始化

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_初始化 逻辑型 初始化软件参数,必须最先执行(快验除外).

参数列表

参数名 参数类型 可空 说明
授权域名 文本型 授权域名
访问端口 整数型 网站端口,可空,默认为80端口.仅支持3种端口号,80,443,999 端口解释:80为http协议,443为https协议,如网站启用https,请使用443端口.999为http指定端口,方便未备案域名使用大陆服务器.
通用秘钥 文本型 通用秘钥(webKey),购买时获得
软件ID 文本型 软件ID,网页后台添加软件后获取
通讯秘钥 文本型 通讯秘钥,网页后台添加软件后获取
客户端sign算法 文本型 客户端sign算法,网页后台添加软件后获取
服务端sign算法 文本型 服务端sign算法,网页后台添加软件后获取
模块MD5 文本型 购买授权后,在”护卫盾官网-用户中心-我的授权”中,复制即可.

5. 护卫盾_取软件数据

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取软件数据 文本型 根据提交参数名,返回网页端设置的软件数据,例如软件名,版本号

参数列表

参数名 参数类型 可空 说明
节点名 文本型 name=软件名,versioninfo=版本管理器中所有数据(json格式由旧到新排列),version=服务端最新版本号,heartbeattime=心跳时间,notice=客户端公告,qq=客服qq,website=官网地址,loginimg=登录页面图片,clientip=客户端IP地址,deduct=转绑扣除数量,login=登录方式(0:账号密码登录,1:充值卡登录),type=计费模式(0:计时,1:计点),para=软件自定义常量(注意,只有登录成功才能取到此值.),captcha=需要验证码的位置(如此值包含 captcha_login 需要登录验证码,包含 captcha_recharge 充值验证码,包含 captcha_reg 注册验证码,包含 captcha_repwd 改密验证码[同时包含发送邮件和修改密码]))

6. 护卫盾_取云端独立自定义常量

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取云端独立自定义常量 文本型 可获取云端独立自定义常量,根据类型参数不同,可获得软件独立自定义常量、用户独立自定义常量。

参数列表

参数名 参数类型 可空 说明
类型 整数型 0=软件独立自定义常量,1=用户独立自定义常量
常量名 文本型 服务端新建常量时的常量名

7. 护卫盾_取软件版本数据

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取软件版本数据 文本型 根据提交参数名,返回网页端设置的软件数据管理器中对应的版本信息,例如更新包地址、更新后版本号等

参数列表

参数名 参数类型 可空 说明
客户端版本号 文本型 当前客户端版本号
节点名 文本型 注意大小写:updateUrl=更新包地址,newVer=更新后版本号,completeUrl=完整包下载地址,forceUpdate=是否强制更新(yes/no),visible=前台是否可见(yes/no),command=更新前后执行命令

8. 护卫盾_取软件自定义常量节点值

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取软件自定义常量节点值 文本型 根据提交参数,返回软件自定义常量中指定节点的值,只有用户正常登陆,才会返回此值,如果用户到期,且”允许到期登陆”,那么也会返回此值(也属于正常登陆).注意,如使用此命令,必须保证软件自定义常量为标准JSON格式

参数列表

参数名 参数类型 可空 说明
节点名 文本型 例 : 软件自定义常量为 {“提交地址”:”xxx.com”,”version”:”1.0”},则 : 护卫盾_取软件自定义常量节点值(“提交地址”); 返回:xxx.com

9. 护卫盾_取验证码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取验证码 文本型 获取验证码,返回验证码图片的本地路径(jpeg格式),可在任何需要验证码的地方调用

参数列表

无参数


10. 护卫盾_取机器码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取机器码 文本型 取机器码,仅用作用户复制后发给作者,使用护卫盾_绑定本机()时,无需传入机器码

参数列表

无参数


11. 护卫盾_注册通行证

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_注册通行证 逻辑型 注册通行证,成功返回true,失败返回false,如果失败可取错误查看失败详情.

参数列表

参数名 参数类型 可空 说明
用户名 文本型 用户名
密码 文本型 密码
安全方式 文本型 邮箱或手机号码,根据后台配置(系统设置-验证设置-注册绑定)
安全码 文本型 邮箱或手机验证码(系统设置-验证设置-注册绑定)如要求验证,则必须填写,否则可空
推荐人 文本型 推荐人账号或邀请码,可空
验证码 文本型 验证码,如果 护卫盾_取软件数据(“captcha”) 中包含 “captcha_reg” , 则需要填写验证码,否则可留空.
三方平台标记 文本型 weichatOP=微信开放平台,wechatOA=微信公众平台,QQ=QQ互联,当用户通过扫码登录时,未绑定账号,则可传入此参数注册,注册成功后自动绑定.常规注册可留空.
openid 文本型 三方登录获取到的openid,当用户通过扫码登录时,未绑定账号,则可传入此参数注册,注册成功后自动绑定.常规注册可留空.

12. 护卫盾_发送安全码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_发送安全码 逻辑型 发送安全码

参数列表

参数名 参数类型 可空 说明
用户名 文本型 用户名
发送标记 文本型 reg=注册验证码,rePwd=改密验证码
安全方式 文本型 mail=邮件验证码,phone=手机验证码
接收地址 文本型 绑定邮箱或手机,如果安全方式=mail,则为邮箱,如果安全方式=phone,则为手机号码
验证码 文本型 验证码,如果 护卫盾_取软件数据(“captcha”) 中包含 “captcha_repwd” , 则需要填写验证码,否则可留空.

13. 护卫盾_修改密码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_修改密码 逻辑型 修改密码,成功返回true,失败返回false,如果失败可取错误查看失败详情.

参数列表

参数名 参数类型 可空 说明
用户名 文本型 用户名
新密码 文本型 新密码
安全码 文本型 邮件或短信验证码
验证码 文本型 验证码,如果 护卫盾_取软件数据(“captcha”) 中包含 “captcha_repwd” , 则需要填写验证码,否则可留空.

14. 护卫盾_充值

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_充值 逻辑型 用户充值.成功返回真,失败返回假

参数列表

参数名 参数类型 可空 说明
用户名 文本型 欲充值的用户名
充值卡号 文本型 充值卡号
验证码 文本型 验证码,如果 护卫盾_取软件数据(“captcha”) 中包含 “captcha_recharge” , 则需要填写验证码,否则可留空
到期时间回调 文本型 可传入变量,充值成功后,将用户到期时间写入该变量
点数余额回调 整数型 可传入变量,充值成功后,将用户点数余额写入该变量
账户余额回调 双精度小数型 可传入变量,充值成功后,将用户账户余额写入该变量

15. 护卫盾_加入黑名单

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_加入黑名单 逻辑型 添加黑名单

参数列表

参数名 参数类型 可空 说明
黑名单号码 文本型 黑名单号码,可以是IP地址或机器码,IP地址:禁止一切访问(包括网站),机器码:禁止客户端访问(不包括网站,因为网站获取不到机器码,无法判断.)
添加备注 文本型 例如添加的理由

16. 护卫盾_登录

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_登录 逻辑型 用户登录,如登录失败,请使用 护卫盾_取错误信息();获取失败错误信息.

参数列表

参数名 参数类型 可空 说明
用户名 文本型 账号密码模式为登录账号,充值卡登录为卡号.
密码 文本型 账号密码模式为登录密码,充值卡登录无需填写.
验证码 文本型 验证码,如果 护卫盾_取软件数据(“captcha”) 中包含 “captcha_login” , 则需要填写验证码,否则可留空.
本地版本号 文本型 可空,如传入本地版本号,则会在在线用户列表中显示客户端本地版本号.

17. 护卫盾_取用户资料

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取用户资料 文本型 获取登录用户信息,根据提交参数名,返回指定用户数据.

参数列表

参数名 参数类型 可空 说明
节点名 文本型 username=用户名,password=密码,token=登录token,auth=登录令牌,endtime=到期时间,point=点数余额,balance=账户余额,para=用户自定义常量,bind=用户绑定信息

18. 护卫盾_取用户自定义常量节点值

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取用户自定义常量节点值 文本型 根据提交参数,返回用户自定义常量中指定节点的值,只有用户正常登陆且未到期/有点数,才会返回此值.注意,如使用此命令,必须保证用户自定义常量为标准JSON格式

参数列表

参数名 参数类型 可空 说明
节点名 文本型 例 : 用户自定义常量为 {“版本”:”普通版”,”高级功能”:”ON”},则 : 护卫盾_取用户自定义常量节点值(“版本”); 返回:普通版

19. 护卫盾_扣点

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_扣点 逻辑型 扣点.

参数列表

参数名 参数类型 可空 说明
扣除点数 整数型 扣点数,最小为1点
扣除日志 文本型 扣点备注,管理可在后台查看,用户可在个人中心查看(请在”系统设置”中开启”记录扣点日志”)
扣除间隔 整数型 扣点间隔(单位:秒),0为不限,即每次都扣点.大于零代表指定间隔内不重复扣点,例如1天只扣一次点,那么间隔就是86400秒,需在软件后台开启:记录扣点日志.不明白请看API文档.

20. 护卫盾_扣时

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_扣时 逻辑型 扣时.

参数列表

参数名 参数类型 可空 说明
扣除时间 整数型 扣时数,单位:分钟,最小为1分钟
扣除日志 文本型 扣时备注,管理可在后台查看,用户可在个人中心查看(请在”系统设置”中开启”记录扣点日志”)
扣除间隔 整数型 扣时间隔(单位:秒),0为不限,即每次都扣时.大于零代表指定间隔内不重复扣时,例如1天只扣一次时,那么间隔就是86400秒,需在软件后台开启:记录扣点日志.不明白请看API文档.

21. 护卫盾_扣除余额

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_扣除余额 逻辑型 扣余额,登录模式为:账号密码 时有效

参数列表

参数名 参数类型 可空 说明
扣除金额 双精度小数型 扣除金额,单位:元,最小为0.01元
扣除日志 文本型 扣除备注,管理可在后台查看,用户可在个人中心查看(请在”系统设置”中开启”记录扣点日志”)
扣除间隔 整数型 扣除间隔(单位:秒),0为不限,即每次都扣除.大于零代表指定间隔内不重复扣除,例如1天只扣一次余额,那么间隔就是86400秒,需在软件后台开启:记录扣点日志.不明白请看API文档.

22. 护卫盾_绑定用户数据

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_绑定用户数据 逻辑型 绑定用户资料,例如配置云备份,绑定游戏号等.用户登录成功状态下,可使用:护卫盾_取用户资料(“bind”)获取此绑定资料.

参数列表

参数名 参数类型 可空 说明
绑定内容 文本型 欲写入的数据,理论无长度限制,由于数据加密传输,数据越长加密时间越慢,因此不建议数据太大.

23. 护卫盾_绑定本机

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_绑定本机 逻辑型 绑定机器码,自动将指定账户绑定本机,无需传入机器码,自动获取,如已达到绑定上限,则删除最先绑定的机器码.转绑扣时扣点自动完成,无需独立扣除.

参数列表

参数名 参数类型 可空 说明
用户名 文本型 欲绑定的用户名,无需传入机器码,机器码自动获取.

24. 护卫盾_调用PHP函数

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_调用PHP函数 文本型 动态调用自定义函数(PHP语法)

参数列表

参数名 参数类型 可空 说明
函数名 文本型 函数名,例如:function test($a,$b){return $a + $b},函数名为:test
参数值 文本型 参数值,例如:function test($a,$b){return $a + $b},参数值为:3,4 参数分隔符为英文半角逗号(,)

25. 护卫盾_心跳

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_心跳 逻辑型 心跳包,保持与服务器通讯.请注意,此命令有两种功能,1.单次心跳,2.循环心跳,具体请看参数<1>说明.

参数列表

参数名 参数类型 可空 说明
心跳周期 整数型 心跳周期,单位:秒,为0则单次心跳,若大于0,则最小120秒,最大不限,只要调用过1次循环心跳,则程序退出前均有效,若自动心跳,则此处心跳时间必须与后台软件设置中的”心跳时间”相同.
离线回调 子程序指针 离线回调指针,账户离线时调用此函数.子程序指针无需任何参数和返回值.如取离线原因,请使用:护卫盾_取错误信息(),如不回调,则直接退出.
登录令牌 文本型 登录成功时返回。用于非主进免登录心跳,也可以理解为静默登录功能。任意进程使用登录令牌心跳后,均可以在不调用护卫盾_登录()函数的情况下调用护卫盾其它函数,主进程无需传入登录令牌。

26. 护卫盾_配置保存

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_配置保存 逻辑型 快速写配置,自动创建”程序目录\config.dat”,保存程序所需配置,配合:护卫盾_配置读取();读取.

参数列表

参数名 参数类型 可空 说明
项名 文本型 配置名称
项值 文本型 配置值

27. 护卫盾_配置读取

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_配置读取 文本型 快速读配置,可读取:护卫盾_配置保存();函数写下的配置.

参数列表

参数名 参数类型 可空 说明
项名 文本型 配置名称
默认值 文本型 默认返回值

28. 护卫盾_过滤HTML标签

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_过滤HTML标签 文本型 清除字符串中的html标签

参数列表

参数名 参数类型 可空 说明
HTML字符串 文本型 待过滤的字符串

29. 护卫盾_快验

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_快验 逻辑型 初始化软件参数,必须最先执行(快验除外).

参数列表

参数名 参数类型 可空 说明
授权域名 文本型 授权域名
访问端口 整数型 网站端口,可空,默认为80端口.仅支持3种端口号,80,443,999 端口解释:80为http协议,443为https协议,如网站启用https,请使用443端口.999为http指定端口,方便未备案域名使用大陆服务器.
通用秘钥 文本型 通用秘钥(webKey),购买时获得
软件ID 文本型 软件ID,网页后台添加软件后获取
通讯秘钥 文本型 通讯秘钥,网页后台添加软件后获取
客户端sign算法 文本型 客户端sign算法,网页后台添加软件后获取
服务端sign算法 文本型 服务端sign算法,网页后台添加软件后获取
模块MD5 文本型 购买授权后,在”护卫盾官网-用户中心-我的授权”中,复制即可.
自定义常量 文本型 软件自定义常量,只要用户未付款,此处一定留空. 如果用户付款,请将此软件的自定义常量写到此处,将不再联网验证.也可在软件调试时使用.

30. 护卫盾快验取软件自定义常量

函数信息

函数名 返回值类型 公开 功能说明
护卫盾快验取软件自定义常量 文本型 根据提交参数返回快验软件信息.

参数列表

参数名 参数类型 可空 说明
节点名 文本型 para=软件自定义常量,clientip=客户端IP

31. 护卫盾快验取软件自定义常量节点值

函数信息

函数名 返回值类型 公开 功能说明
护卫盾快验取软件自定义常量节点值 文本型 快速验证通过后,根据提交参数,返回快验自定义常量中指定节点的值,注意,如使用此命令,必须保证快验自定义常量为标准JSON格式,否则请使用:护卫盾快验取软件自定义常量(); 获取数据后自行处理.

参数列表

参数名 参数类型 可空 说明
节点名 文本型 例 : 软件自定义常量为 {“提交地址”:”xxx.com”,”version”:”1.0”},则 : 护卫盾快验取软件自定义常量节点值(“提交地址”); 返回:xxx.com

32. 护卫盾_登出

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_登出 逻辑型 退出登录,程序退出前可调用此命令,服务端立即更新用户状态,否则需要等待无心跳通讯后,才能判定用户退出

参数列表

无参数


33. 护卫盾_取充值卡列表

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取充值卡列表 文本型

参数列表

参数名 参数类型 可空 说明
用户名 文本型
获取超级会员卡 逻辑型

34. 护卫盾_取支付二维码

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取支付二维码 文本型

参数列表

参数名 参数类型 可空 说明
用户名 文本型
卡类ID 文本型

35. 护卫盾_取支付状态

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取支付状态 逻辑型

参数列表

参数名 参数类型 可空 说明
订单号 文本型

36. 护卫盾_取三方登录参数

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取三方登录参数 文本型 获取三方登录参数

参数列表

参数名 参数类型 可空 说明
平台标记 文本型 wechatOP:微信开放平台,wechatOA:微信公众平台,QQ:QQ互联
参数名称 文本型 wechatOPAppId:微信开放平台APPID,仅在平台标记为:wechatOP时返回. <br>wechatOAAppId:微信公众平台APPID,仅在平台标记为:wechatOA时返回.<br>QQAppId:QQ互联APPID,仅在平台标记为:QQ时返回.<br>guid:标识符,此标识符在后续检测登录状态要用到<br>loginUrl:登录地址,可直接使用浏览器打开<br>unbindUrl:解绑地址,可直接使用浏览器打开<br>redirectUri:登录回调地址,webAPI无用,除非你想自行集成微信开放平台<br>unbindUri:解绑回调地址,webAPI无用,除非你想自行集成微信开放平台

37. 护卫盾_取三方登录状态

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_取三方登录状态 整数型 取三方登录扫码状态

参数列表

参数名 参数类型 可空 说明
平台标记 文本型 wechatOP:微信开放平台,wechatOA:微信公众平台,QQ:QQ互联
guid 文本型 通过:护卫盾_取三方登录参数()获取到的guid
数据类型 文本型 openid:获取openid(登录时用到),code:获取状态码(检测是否登录[279:尚未扫码,280:扫码成功但未绑定账户,需要提示用户注册或绑定],200扫码成功且已绑定账户,通过openid登录即可)

38. 护卫盾登录三方

函数信息

函数名 返回值类型 公开 功能说明
护卫盾登录三方 逻辑型 用户登录,如登录失败,请使用 护卫盾_取错误信息();获取失败错误信息.

参数列表

参数名 参数类型 可空 说明
平台标记 文本型 平台标记,wechatOP=微信开放平台,wechatOA=微信公众平台,QQ=QQ互联
openid 文本型 检测登录状态获取到的openid,注意参数名称的大小写
本地版本号 文本型 可空,如传入本地版本号,则会在在线用户列表中显示客户端本地版本号.

39. 护卫盾_三方登录账号绑定

函数信息

函数名 返回值类型 公开 功能说明
护卫盾_三方登录账号绑定 逻辑型 三方登录绑定账号

参数列表

参数名 参数类型 可空 说明
平台标记 文本型 wechatOP:微信开放平台,wechatOA:微信公众平台,QQ:QQ互联
用户名 文本型 绑定用户名
密码 文本型 用户密码
openid 文本型 三方平台开放账号,微信开放平台为 unionid
验证码 文本型 验证码,如果 hwd_getSoftInfo(“captcha”) 中包含 “captcha_reg” , 则需要填写验证码,否则可留空.