青檸網絡驗證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的形式提交
不懂的請參考我們提供的易語言源碼
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&mail=123456789@qq.com&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&mail=123456789@qq.com
參數:
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:成功與錯誤描述