查看: 2403|回复: 2

[充值模块] WebApi接口教程文档!1.02版本

[复制链接]
发表于 2018-11-12 17:43:30 | 显示全部楼层 |阅读模式

马上注册,结交更多好友,享用更多功能,让你轻松玩转社区

您需要 登录 才可以下载或查看,没有账号?立即注册

x

插件特色:


本插件可使站长,无缝对接外部app、web、易语言、C++、PY、GO、java等软件内嵌api对接接口。
本插件建议只允许站长使用,如需写更强大的网络验证类用户操作软件,请自己做好软件操作限制加密。

声明:


1、服务器环境必须支持CURL组件,不过一般都支持。
2、本插件在正式使用前,为保证数据库数据安全,必须要重新逐一测试了解功能后,再正式开放使用。

3、请保护好自己的传输密钥,针对外部软件调用时,一定要注意加密,防止泄漏。
4、在使用前请认真阅读操作文档,只对插件功能负责,由于其他原因造成的信息泄露与本站无关。

功能说明:

1、在参数设置中,传输密钥,可设置3个,每一个密钥都可以调用全部接口;

2、本接口可同时接收GET、POST参数传输,返回结果JSON形式;
3、本插件对方法、参数入口都进行了严格过滤,参数不齐全、方法不对都返回错误提示信息;
4、本插件严格遵循官方安全过滤,极大提高安全性,防止恶意注入;
5、本插件适用discuz所有数据库增、减、改、查,如需定制请联系客服。

[pre]接口形式解析:
接口地址:http://localhost/plugin.php?id=xinxiu_api:{接口名称}&key={传输密匙}或{管理密钥}&action={接口方法}&参数1=值&参数2=值……
--------------------------------------------------------------
接口名称:每个新增一个接口就会产生一个,这个在下面接口教程内有分类;
传输密钥:插件后台三个传输密钥,只要其中一个就可以;
管理密钥:与传输密钥不能同时使用,管理密钥在后台进行特殊操作时使用,没有就忽略;
接口方法:每个接口文件下都会有多个接口方法,具体看教程;
参数=值:根据接口方法的参数要求,进行传值,可使用GET或POST方式。

返回数据:
{"code":200,"result":"OK","count":2,"data":{"uid":"1","username":"admin"}}
--------------------------------------------------------------
code:返回状态码,正常为200;
result:返回状态码对应的信息;
count:返回data数组中的数量;
data:返回获得值。具体对应参数请到http://www.xinxiuvip.com/forum.php?mod=viewthread&tid=49&page=1查阅![/pre]
[pre]
user接口说明:
接口地址:
http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action={接口方法}

实例解析:
1、fetch_uid_by_username,获取用户uid,需要传入参数username=admin
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action=fetch_uid_by_username&username=admin
返回:{"code":200,"result":"OK","count":2,"data":{"uid":"2","username":"admin"}}

注意:如果是中文用户名,返回数据data中username参数就会以Unicode编码方式返回,如需获取中文用户名,进行Unicode转换即可;
特别注意:为减少因username中文名字报错,下面所有涉及用户接口调用时,均采用提交uid参数,不接收username参数。

2、fetch_by_uid,按uid获取用户信息,需传入参数uid=1
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action=fetch_by_uid&uid=1
返回:{"code":200,"result":"OK","count":8,"data":{"uid":"1","username":"admin","email":"admin@admin.com","groupid":"1",
"grouptitle":"\u7ba1\u7406\u5458","extgroupids":"","credits":"6","regdate":"2018-11-10 09:06:33"}}

3、fetch_by_groupid,按groupid获取所有会员组用户信息,需传入参数groupid=1(会员组id)
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&op=fetch_by_groupid&groupid=1
返回:{"code":200,"result":"OK","count":1,"data":[{"uid":"1","username":"admin","email":"admin@admin.com","groupid":"1","grouptitle":"\u7ba1\u7406\u5458","extgroupids":""}]}

4、fetch_by_type,按类型获取用户组,需传入参数type,可为空type默认为special,自定义用户组('system'=>系统用户组,'special'=>自定义用户组,'member'=>会员用户组))
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action=fetch_by_type&type=special
返回:{"code":200,"result":"OK","count":5,"data":{"16":{"groupid":"16","grouptitle":"\u5b9e\u4e60\u7248\u4e3b"},"17":{"groupid":"17","grouptitle":"\u7f51\u7ad9\u7f16\u8f91"},"18":{"groupid":"18","grouptitle":"\u4fe1\u606f\u76d1\u5bdf\u5458"},"19":{"groupid":"19","grouptitle":"\u5ba1\u6838\u5458"},"20":{"groupid":"20","grouptitle":""}}}

5、user_login,用户登录验证,需传入参数($username,$password,$questionid,$answer,$sqlbm),
$username :用户名,必填
$password :用户密码,必填
$questionid :用户问题id(1、2、3、4、5),无设置安全问题时->此参数不传,有安全问题时根据官方默认提示问题顺序为1=母亲叫什么名字,后面2、3、4、5以此类推,可为空
$answer :用户问题答案;设置了就填,没设置就忽略,可为空
$sqlbm :数据库编码(默认为utf8编码,值包括:空、utf8、gbk),为了解决GBK数据库中文编码问题,如果是GBK就传入参数$sqlbm=gbk,如果是utf8就可以忽略,可为空
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action=user_login&type=special&username=admin&password=123456
返回:{"code":200,"result":"OK","count":5,"data":{"uid":3,"username":"\u4f60\u597d\u554a","password":"52a832ad3de668c1c34eb56acf3b3c84","questionid":0,"answer":""}}
[/pre]
[pre]1.02版本新增功能:
user接口说明:
6、get_avatar,获取用户头像,需传入参数($uid,$size),
$uid : 用户uid;
$size : 头像大小参数,默认$size=middle,包含('big', 'middle', 'small')) 可为空
地址:http://localhost/plugin.php?id=xinxiu_api:user&key={传输密匙}&action=get_avatar&uid=1
返回:
{"code":200,"result":"OK","count":3,"data":{"uid":1,"size":"middle","avatar":"<img src=\"http:\/\/localhost\/uc_server\/avatar.php?uid=1&size=middle\" \/>"}}

admin接口说明:(高级操作)
接口地址:
http://localhost/plugin.php?id=xinxiu_api:admin&key={管理密匙}&action={接口方法}
实例解析:
1、add_credits,对用户积分增、减、改,需要传入参数($uid,$coin,$do,$number)都是必传参数
$uid : 用户uid,不能传用户名,如需查询用户名uid,请使用user接口fetch_uid_by_username方法获取
$coin :积分编号,对extcredits1积分操作时,填写1;extcredits1~extcredits8,根据对应的参数积分进行填写(1-8数字)
$do :操作方法:do=1时为加积分;do=2时为减积分;do=3时为设置积分(即输入多少就是多少积分);
$number :积分数,对用户增、减、改积分的数量,填入正数,不能输入负数及小数
地址:http://localhost/plugin.php?id=xinxiu_api:admin&key={管理密匙}&action=add_credits&uid=1&coin=2&do=3&number=1000
返回:{"code":200,"result":"OK","count":2,"data":{"uid ":1,"extcredits2":1000}}
[/pre]


更多内置接口正在开发中。如果你有特殊接口可与客服联系。
除了discuz内置数据接口,本人承接其他插件数据接口开发。


版本下载页面:http://www.xinxiuvip.com/forum.php?mod=viewthread&tid=50




回复

使用道具 举报

 楼主| 发表于 2018-12-5 19:32:24 | 显示全部楼层
本帖为密码帖 ,请输入密码 
回复

使用道具 举报

发表于 2019-5-7 14:40:48 | 显示全部楼层
这个能接受post请求么? 比如我想做一个发帖的接口
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

客户服务
周一至周日:09:00 - 21:00
客服QQ:3188639 QQ交流群:281079920

新秀网络验证是新一代简洁高效、云服务、独创功能融一体的新型管理收费框架系统,本框架专注于Discuz!二次开发规范要求,独立框架、代码分离、逻辑分离、独特加密、动态验证新型框架系统,专心服务客户。

Archiver|手机版|新秀网络验证系统 ( 豫ICP备2021033257号-1 )

GMT+8, 2022-5-25 05:32 , Processed in 0.228167 second(s), 56 queries , Redis On.

快速回复 返回顶部 返回列表