WDlinux官方论坛 - Powered by Discuz! Board

标题: [教程] wdCPv3的API使用说明文档(20171020更新) [打印本页]

作者: admin 时间: 2016-3-20 15:36 标题: wdCPv3的API使用说明文档(20171020更新)

wdCP系统API文档说明

从wdCP3开始，将会不断完善并提供完整的API调用系统
目前的API系统功能，包括如下三部分的功能
1 站点的管理功能
2 ftp的管理功能
3 mysql的管理功能

要使用API功能，首先需要在后台上设置API的IP地址和API的KEY
IP地址是允许提交的服务器地址，如果不限制，可以设置为0.0.0.0
APIKEY是提交通信验证的密钥
URL参数为key,值为APIKEY+提交者的IP地址的MD5值
如后台设置的密钥是123456，提交者的IP是192.168.10.10
则key=md5(123456192.168.10.10)
在所有的提交方法里，增加key参数与值

API地址：
http://ip:8080/api/类别/方法,如
http://ip:8080/api/site/add
支持get,post两种方式提交
如有修改过默认的8080端口，需要修改为相应的新端口

通用规则
用户名，目录名只能为字母，数字，下划线

执行结果，以json数据格式返回显示
errCode值为0表示成功，1表示错误
以创建/新建时，会有一个返回ID，要保存好此ID，后续修改，删除等操作均要根据此ID进行
如下：
{
  "errCode": "0",
  "id": "0",
  "msg": "操作成功"
}
返回参数20171020更新

site部分
http://ip:8080/api/site/(add|edit|del)
http://ip:8080/api/site/add?domain=testtt.com
add方法，表单元素有
domain
domains
domainm
dirindex
redir
reurl
accesslog
errorlog
limitdir
phps PHP版本，默认为0，必选项
db_flag  如要创建数据库及用户，值为1，如不创建，为0
dbname
dbuser
dbpasswd
cdbpasswd
dbcharset
ftp_flag 如要创建FTP用户，值为1，如不创建，为0
ftpuser
ftppasswd
cftppasswd

edit方法，表单元素有
id
domains
domainm
dirindex
redir
reurl
accesslog
errorlog
limitdir

del方法，表单元素有
id 用户ID

FTP部分
http://ip:8080/api/ftp/(add|edit|del|chgpw)
http://ip:8080/api/ftp/add?username=ftpu1&password=123456&password2=123456
add方法，表单元素有
username 用户名
password 密码
password2 确认密码
dir 目录(如为空，则使用站点根目录加用户名，如/www/web/user,也可使用绝对路径)
quotafiles
quotasize
ulbandwidth
dlbandwidth

edit方法，表彰元素有
id 创建FTP时的用户ID
quotafiles
quotasize
ulbandwidth
dlbandwidth

del方法
id 用户ID

chgpw方法，表彰元素有
id
用户ID
password 原密码
password1 新密码
password2 确认新密码

mysql部分
http://ip:8080/api/mysql/(add|del|chgpw)

add方法，表单元素有
username
password
cpassword
dbname
dbcharset
dbsize
dbhost

del方法
id 数据库或用户ID

chgpw方法，表彰元素有
id
数据库或用户ID
dbuser 数据库用户
dbhost 主机名，默认为localhost
password 新密码
cpassword 确认新密码

更多将在后续公布

作者: lanyeit 时间: 2016-3-20 19:50

非常好......................

作者: swordnetho 时间: 2016-3-20 21:42

有点小激动了呢:victory:

作者: featue 时间: 2016-3-21 10:24

very good..................

作者: inyhow 时间: 2016-3-21 14:12

回复 1# admin

太好了，可以自己创建站群了

作者: inyhow 时间: 2016-3-21 14:38

回复 1# admin 希望wdcp系统加入自动批量远程下载或本地上传网站源码的 api功能。

作者: goolwell 时间: 2016-3-23 11:59

能否做成模拟da 模式这样功能就可以介入更多支持da面板的系统了

作者: admin 时间: 2016-3-23 12:34

没用过，da 模式是怎样的，说说看

作者: wyoyoo 时间: 2016-3-23 16:59

把鸡放冰箱里面的感觉！

作者: admin 时间: 2016-3-23 20:35

回复 6# inyhow

这个可以有

作者: flying 时间: 2016-3-24 17:45

加油！真心感谢管理员一直以来对WDCP控制面板的维护和升级，使得我们在使用linux部署网站更方便更简单！谢谢

作者: mysql99 时间: 2016-4-2 23:36

回复 8# admin
就是模拟da 控制面板的对外api参数，可以查看da帮助。其实也很简单。无非是ftp.mysql，web.这几项。。。如果开发出来，那国内很多主机系统都可以对接。

作者: inyhow 时间: 2016-4-16 16:17

回复 1# admin

请问下，qq群文件里面的class——wdcp.php是否是放在wdcp v2版本上使用的，而wdcp v3直接使用 api 连接

作者: 朱朝兵 时间: 2016-4-21 13:12

非常棒！

作者: roger_liu 时间: 2016-4-23 12:50

请问不显示第一个页面啊？

作者: tracy0103 时间: 2016-4-26 20:00

好像可以做个自动化管理了

作者: huzs1622 时间: 2016-6-16 15:02

有了API就强大了。

作者: daolang 时间: 2016-6-28 15:15

本帖最后由 daolang 于 2016-6-28 15:16 编辑

初步试了下，楼主的API很棒，都能使用。

请问楼主，有没有提供文件管理部分的API，现在需要建立好网站，拷贝一些网页文件进去，
不知道有没有相关的接口可以实现？

作者: admin 时间: 2016-6-28 17:12

目前还没有文件管理部分

作者: 提问题 时间: 2016-6-30 22:48

回复 19# admin

list api没有啊怎么取列表操作啊

作者: 349748588 时间: 2016-7-18 10:59

怎么获得金币

作者: avast 时间: 2016-7-19 14:18

这是一个划时代的功能！

作者: jjp 时间: 2016-7-23 20:13

来学习学习学习

作者: jjp 时间: 2016-7-23 20:15

学习学习学习

作者: geogis 时间: 2016-7-27 09:13

期待再次更新

作者: qmw建材家居 时间: 2016-7-28 14:28

真心感谢管理员一直以来对WDCP控制面板的维护和升级，使得我们在使用linux部署网站更方便更简单

作者: acanzx 时间: 2016-9-2 20:37

好东西啊！

作者: sy88618816 时间: 2016-10-18 20:29

感谢管理员

作者: inyhow 时间: 2016-11-1 11:31

http://118.236.0.232:8080/api/site/add?domain=aw05.com&key=md5(w123@192.168.0.1)
创建域名是这样的吗？为什么我创建提示{"code":"300","message":"api的KEY错误！"}

图片附件: QQ截图20161101112219.jpg (2016-11-1 11:26, 8.37 KB) / 下载次数 8387
http://wdlinux.cn/bbs/attachment.php?aid=6780&k=e8ce0aaefe4c91bbe8512ca15f1cba31&t=1713240865&sid=I1E86T

图片附件: 1.jpg (2016-11-1 11:28, 18.01 KB) / 下载次数 8291
http://wdlinux.cn/bbs/attachment.php?aid=6781&k=8265009b137e8d86633a5af117bf484e&t=1713240865&sid=I1E86T

作者: win68 时间: 2016-12-5 08:21

老大，能否开发个整合WHMCS的API插件，可以在WHMCS开通免费空间了

作者: daolang 时间: 2016-12-19 21:31

用API操作新建站点时候，经常遇到wdcp挂起，不知道如何开启相关日志，进行排查？
网站80端口的能正常访问，但是面板不行，
看面板进程还在，访问8080端口时候，就提示：
无法访问此网站

xxx.xxx.xxx.xxx 拒绝了我们的连接请求。

请试试以下办法：

检查网络连接
[url=data:text/html,chromewebdata#buttons]检查代理服务器和防火墙[/url]

ERR_CONNECTION_REFUSED

作者: vsxp 时间: 2017-2-5 23:28

辛苦了，感谢。

作者: tangn 时间: 2017-2-14 11:47

wdcp后台设置的
API访问IP:0.0.0.0,
API登录Key：123456;
提交地址http://192.168.177.133:8080/api/site/add?key=md5(123456192.168.177.133)
但是一直提示{"code":"300","message":"api的KEY错误！"},
有人知道怎么解决吗

作者: tangn 时间: 2017-2-14 11:50

回复 30# inyhow

我也是遇到这样

作者: yangyiyan 时间: 2017-2-17 00:39

回复 1# admin

66666666

作者: duzhenyong 时间: 2017-3-28 17:56

没有提供demo吗大神

作者: underwood 时间: 2017-5-19 23:36

好贴

顶帖前来学习

作者: liu00700 时间: 2017-11-14 16:05

能添加个列表的功能吗？或者根据域名查询，是否已创建，因为我在调用API时，经常性的出错，导致站点明明才刚创建好了，可是我收到的返回是站点已存在，包含数据库也是一样

作者: liu00700 时间: 2017-11-14 16:11

或者添加个能根据域名查询站点的ID或者信息之类的

作者: yjq911 时间: 2018-1-4 18:28

请问api可以支持修改目录权限吗

作者: p270228163 时间: 2018-1-26 11:25

回复 8# admin

如果再有打包上传, 解压, 那就完美了

作者: hionline 时间: 2018-6-11 11:18

真心不错，感谢wdcp，希望这个API手册更完善些，那些字段对应的含义没有，只能靠猜测和测试啊

作者: lht131421 时间: 2018-9-15 21:44

问题是这个api的实用性在哪里呢，真心搞不太懂，哪位朋友能讲解一下么？

作者: p270228163 时间: 2018-11-21 11:08

http://ip:8080/api/site/list 没有列表
vhostdir 缺少目录设置参数

希望可以添加, 或者怎么修改呢

作者: featue 时间: 2019-4-27 20:10

回复 45# p270228163

有list的方法了吗？主要想调ftp的list

作者: p270228163 时间: 2019-8-27 22:42

回复 45# featue

有,
我用 curl 模拟登录, 做了个api
后台的功能都可以模拟, 只做了我需要用的

站点管理, 有站点列表, 不带文件管理
ftp管理
mysql 还没弄, 因为我用的不在本地

欢迎光临 WDlinux官方论坛 (http://wdlinux.cn/bbs/)