运维开发网

青柠网络验证webapi接口说明

运维开发网 https://www.qedev.com 2020-06-17 08:28 出处:网络 作者:运维开发网整理
青柠网络验证webapi接口于2019/6/5 正式上线 什么是webapi接口? Webapi接口就是不管你是什么编程软件,只要有网页访问的函数,就能使用我们的青柠网络验证的所有功能! 每个api返回都有status值,每个status错误值是唯一的 例子: {"status":"1","msg":"初始化成功","notice":"欢迎大家使用我的软件,使用过程遇到问题请联系我哦","vers

青柠网络验证webapi接口于2019/6/5 正式上线

什么是webapi接口?

Webapi接口就是不管你是什么编程软件,只要有网页访问的函数,就能使用我们的青柠网络验证的所有功能!

每个api返回都有status值,每个status错误值是唯一的

例子:

{"status":"1","msg":"初始化成功","notice":"欢迎大家使用我的软件,使用过程遇到问题请联系我哦","version":"1.1","updateAddr":"https://www.lanzous.com/i1bcv5a","reg_give_time":"99999","open_state":"0","bindingMode":"1","reg_give_points":"100"}

Status  = 返回值

Msg = 提示信息

每个api都是以post的形式提交

不懂的请参考我们提供的易语言源码

 

 

青柠网络验证webapi接口说明

 

 

青柠网络验证webapi接口说明

 

Initialize说明:

初始化软件信息,不初始化其他api都无法正常使用,调用成功返回软件信息,如:{"status":"1","msg":"初始化成功","notice":"欢迎大家使用我的软件,使用过程遇到问题请联系我哦","version":"1.1","updateAddr":"https://www.lanzous.com/i1bcv5a","reg_give_time":"99999","open_state":"0","bindingMode":"1","reg_give_points":"100"}

 

调用例子:

http://qnone.cn:88/WebApi/Initialize

post提交数据:appID=23&Key=XF5O65GL2K8N5M67W6118CVWEU8X5C&customCode=1234567&Number=q1033685204

参数:

appID:软件ID,在后台查看

Key:软件的key,在后台查看

customCode:软件的自定义码,在后台查看,可以自己自定义

Number:你的青柠网络验证账号

返回值:

status: 状态码

msg:成功与错误描述

notice:公告(后台可设置)

version:软件的版本号 (后台可设置)

updateAddr:更新地址(后台可设置)

reg_give_time:软件注册赠送时间(后台可设置)

open_state:软件开启状态,0 开放运营,1停止运营(后台可设置)

bindingMode:绑定模式,1 机器码绑定,0 不绑定(后台可设置)

reg_give_points:注册赠送点数(后台可设置)

 

 

Login说明:

登录(帐号密码验证)成功调用返回json,如:

{"status":"1","msg":"登录成功"}

调用例子:

http://qnone.cn:88/WebApi/Login

post提交数据:userName=12345678&password=8888888&ip=127.0.0.1&place=beijing&machineCode=123456789122

参数:

userName :用户的帐号

password :用户的密码

ip:ip地址,请自行写函数获取 (只支持输入纯数字)

place:ip归属地,请自行写函数获取 (支持输入中文)

machineCode:机器码,请自行写函数获取

返回值:

status: 状态码

msg:成功与错误描述

 

 

Register说明:

用户帐号注册。

成功调用返回json,如:{"status":"1","msg":"注册成功"}

调用例子:

http://qnone.cn:88/WebApi/Register

post提交数据:userName=123456789&password=123456789&[email protected]&machineCode=123456789

 

参数:

userName :用户的帐号

password :用户的密码

mail:用户邮箱

machineCode: 机器码,请自行写函数获取

返回值:

status: 状态码

msg:成功与错误描述

 

 

 

ChangePassword说明:

修改用户的登录密码

成功调用返回json,如:{"status":"1","msg":"修改密码成功"}

调用例子:

http://qnone.cn:88/WebApi/ChangePassword

post提交数据:userName=123456789&password=123456789&newpassword=987654321&[email protected]

参数:

userName :用户的帐号名

password:用户的原密码

newpassword:用户要设置的新密码

mail:用户注册的时候预留的邮箱

返回值:

status: 状态码

msg:成功与错误描述

 

 

 

Recharge说明:

给用户帐号充值,延长使用期限

成功调用返回json,如:{"status":"1","msg":"充值成功"}

调用例子:

http://qnone.cn:88/WebApi/Recharge

post提交数据:userName=123456789&Key=8888888888888888

参数:

userName :用户的帐号名

key:充值卡,在后台生成

返回值:

status: 状态码

msg:成功与错误描述

 

 

UnBind说明:

如果帐号绑定机器码,调用此接口可解绑(帐号密码验证)成功调用返回json,如:

{"status":"1","msg":"解绑成功。"}

调用例子:

http://qnone.cn:88/WebApi/UnBind

post提交数据:userName=123456789&password=1234567

参数:

userName :用户的帐号

password :用户的密码

返回值:

status: 状态码

msg:成功与错误描述

 

 

GetUserinfo说明:

登录成功后调用此api可获取到用户信息,成功调用返回json,如:

{"status":"1","msg":"获取用户信息成功","serverTime":"1559724095","staticData":"我是静态数据","privateData":"我是用户数据122","points":"180","userName":"1033685204","expireTime":"2019-12-21 01:21:19","ip":"127.0.0.1","place":"中国北京"}

调用例子:

http://qnone.cn:88/WebApi/GetUserinfo

post提交数据:userName=123456789

参数:

userName :用户的帐号 (这里的账号可填可不填,因为这个api是默认读取登录成功后的账号的用户信息)

返回值:

status: 状态码

msg:成功与错误描述

serverTime:服务器时间

staticData:软件静态数据(后台可修改)

privateData:用户私有信息

points:用户剩余点数

userName:当前登录用户

expireTime:到期时间

ip:登录ip

place:ip归属地

 

 

Deduction说明:

登录成功后调用此api可进行扣点操作,扣点的作用是比如你写了一个功能,你想按次数收费,比如1块钱能用10次,你就可以调用这个扣点api,每次扣点1次即可。

成功调用返回json,如:{"status":"1","msg":"扣点成功。"}

调用例子:

http://qnone.cn:88/WebApi/Deduction

post提交数据:points=1

参数:

points:要扣除的点数

返回值:

status: 状态码

msg:成功与错误描述

 

 

Locking说明:

封停账号,使账号禁止登陆。调用此api后,建议接着调用Heartbeat,检测账号状态,不懂的请参考提供的易语言源码。

成功调用返回json,如:{"status":"1","msg":"成功。"}

调用例子:

http://qnone.cn:88/WebApi/Locking

post提交数据:userName=123456789

参数:

userName :用户的帐号 (这里的账号可填可不填,因为这个api是默认封禁登录成功后的账号)

返回值:

status: 状态码

msg:成功与错误描述

 

 

Heartbeat说明:

登录成功才能使用本函数,本函数请用时钟调用,设置时间1分钟到10分钟左右不等,意思是间隔60秒与服务器通信一次,请勿调用得太频繁,防止访问失败导致错误判断。

成功调用返回json,如:{"status":"1","msg":"心跳正常。"}

调用例子:

http://qnone.cn:88/WebApi/Heartbeat

post提交数据:userName=123456789&password=987654321

参数:

userName :用户的帐号

password :用户的密码

返回值:

status: 状态码

msg:成功与错误描述

 

 

 

SetData说明:

设置用户私有数据,登录后才能使用。

成功调用返回json,如:{"status":"1","msg":"成功。"}

调用例子:

http://qnone.cn:88/WebApi/SetData

post提交数据:content=我是用户数据

参数:

content:要设置的内容

返回值:

status: 状态码

msg:成功与错误描述

 

 

Exit说明:

通知服务器当前用户要退出,然后服务器马上切断之间的会话并设置用户状态为下线。如果用户退出使用软件,请调用此api,否则再次登录的时候会提示账号已在线,要等三分钟后才能登录。

成功调用返回json,如:{"status":"1","msg":"退出成功。"}

调用例子:

http://qnone.cn:88/WebApi/SetData

post提交数据:userName =123456789

 

参数:

userName :用户的帐号(这里的账号可填可不填,因为这个api是默认退出登录成功后的账号)

返回值:

status: 状态码 msg:成功与错误描述

0

精彩评论

暂无评论...
验证码 换一张
取 消