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

admin

wdCP系統(tǒng)API文檔說明

從wdCP3開始，將會不斷完善并提供完整的API調(diào)用系統(tǒng)
目前的API系統(tǒng)功能，包括如下三部分的功能
1 站點的管理功能
2 ftp的管理功能
3 mysql的管理功能

要使用API功能，首先需要在后臺上設(shè)置API的IP地址和API的KEY
IP地址是允許提交的服務(wù)器地址，如果不限制，可以設(shè)置為0.0.0.0
APIKEY是提交通信驗證的密鑰
URL參數(shù)為key,值為APIKEY+提交者的IP地址的MD5值
如后臺設(shè)置的密鑰是123456，提交者的IP是192.168.10.10
則key=md5(123456192.168.10.10)
在所有的提交方法里，增加key參數(shù)與值

API地址：
http://ip:8080/api/類別/方法,如
http://ip:8080/api/site/add
支持get,post兩種方式提交
如有修改過默認(rèn)的8080端口，需要修改為相應(yīng)的新端口

通用規(guī)則
用戶名，目錄名只能為字母，數(shù)字，下劃線

執(zhí)行結(jié)果，以json數(shù)據(jù)格式返回顯示
errCode值為0表示成功，1表示錯誤
以創(chuàng)建/新建時，會有一個返回ID，要保存好此ID，后續(xù)修改，刪除等操作均要根據(jù)此ID進(jìn)行
如下：
{
  "errCode": "0",
  "id": "0",
  "msg": "操作成功"
}
返回參數(shù)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版本，默認(rèn)為0，必選項
db_flag  如要創(chuàng)建數(shù)據(jù)庫及用戶，值為1，如不創(chuàng)建，為0
dbname
dbuser
dbpasswd
cdbpasswd
dbcharset
ftp_flag 如要創(chuàng)建FTP用戶，值為1，如不創(chuàng)建，為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 確認(rèn)密碼
dir 目錄(如為空，則使用站點根目錄加用戶名，如/www/web/user,也可使用絕對路徑)
quotafiles
quotasize
ulbandwidth
dlbandwidth

edit方法，表彰元素有
id   創(chuàng)建FTP時的用戶ID
quotafiles
quotasize
ulbandwidth
dlbandwidth

del方法
id 用戶ID

chgpw方法，表彰元素有
id
用戶ID
password 原密碼
password1 新密碼
password2 確認(rèn)新密碼


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

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

del方法
id 數(shù)據(jù)庫或用戶ID

chgpw方法，表彰元素有
id
數(shù)據(jù)庫或用戶ID
dbuser 數(shù)據(jù)庫用戶
dbhost 主機(jī)名，默認(rèn)為localhost
password 新密碼
cpassword 確認(rèn)新密碼

更多將在后續(xù)公布

p270228163

回復(fù) 45# featue


   有,  
我用 curl 模擬登錄, 做了個api
后臺的功能都可以模擬,  只做了我需要用的


站點管理, 有站點列表, 不帶文件管理
ftp管理
mysql 還沒弄, 因為我用的不在本地

featue

回復(fù) 45# p270228163


   有l(wèi)ist的方法了嗎？主要想調(diào)ftp的list

p270228163

http://ip:8080/api/site/list   沒有列表
vhostdir    缺少目錄設(shè)置參數(shù)

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

lht131421

問題是這個api的實用性在哪里呢，真心搞不太懂，哪位朋友能講解一下么？

hionline

真心不錯，感謝wdcp，希望這個API手冊更完善些，那些字段對應(yīng)的含義沒有，只能靠猜測和測試啊

p270228163

回復(fù) 8# admin


如果 再有  打包上傳,  解壓, 那就完美了

yjq911

請問api可以支持修改目錄權(quán)限嗎

liu00700

或者添加個能根據(jù)域名查詢 站點的ID或者信息之類的

liu00700

能添加個  列表的功能嗎？ 或者根據(jù)域名查詢，是否已創(chuàng)建，因為我在調(diào)用API時，經(jīng)常性的 出錯，導(dǎo)致站點 明明才剛創(chuàng)建好了，可是我收到的返回是  站點已存在，包含數(shù)據(jù)庫也是一樣

underwood

好貼

頂帖前來學(xué)習(xí)

duzhenyong

沒有提供demo嗎 大神

yangyiyan

回復(fù) 1# admin


   66666666

tangn

回復(fù) 30# inyhow


    我也是遇到這樣

tangn

wdcp后臺設(shè)置的
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錯誤！"},
有人知道怎么解決嗎