[教程] wdCPv3的API使用说明文档(20171020更新)

admin

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 确认新密码

更多将在后续公布

p270228163

回复 45# featue


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


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

featue

回复 45# p270228163


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

p270228163

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

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

lht131421

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

hionline

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

p270228163

回复 8# admin


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

yjq911

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

liu00700

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

liu00700

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

underwood

好贴

顶帖前来学习

duzhenyong

没有提供demo吗 大神

yangyiyan

回复 1# admin


   66666666

tangn

回复 30# inyhow


    我也是遇到这样

tangn

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错误！"},
有人知道怎么解决吗