ZenTaoPMS/API機制介紹

禪道項目管理通過底層的框架實現(xiàn)了靈活的API調(diào)用機制。通過禪道的API機制，大家就可以實現(xiàn)很多非常有意思的功能。下面我們以一個實際的例子來向大家展示禪道的API機制。

目錄

• 1 API機制介紹
  • 1.1 頁面的調(diào)用
  • 1.2 超級model調(diào)用接口
  • 1.3 API調(diào)用步驟
• 2 參考來源
• 3 ZenTaoPMS使用手冊導(dǎo)航

API機制介紹

• 禪道提供的API機制都可以通過http協(xié)議獲得，返回的數(shù)據(jù)格式都是json格式的。

• 禪道通過框架共實現(xiàn)了兩種API機制。一種為直接的頁面調(diào)用，一種通過超級model調(diào)用接口，直接調(diào)用model層的方法。

頁面的調(diào)用

• 當(dāng)你訪問禪道的時候，將訪問的url地址中的html換成json，看到的就是json格式的數(shù)據(jù)。
• 比如http://pms.zentao.cn/project-task-8.html，返回的網(wǎng)頁格式，把后面的.html改成.json，返回的是什么？對了，返回的是json格式的數(shù)據(jù)。
• 如果是GET 方式，那么只需要將t參數(shù)改成json，http://pms.zentao.cn/?m=project&f=task&t=json.

超級model調(diào)用接口

• 頁面的調(diào)用，存在一定的局限，比如返回的數(shù)據(jù)可能沒有你想要的，或者返回了你不需要的數(shù)據(jù)。為此，我們特地準(zhǔn)備了一個超級model調(diào)用接口。該接口的使用方式：

1. 首先要為相應(yīng)的帳號增加超級model調(diào)用接口的訪問權(quán)限。
2. 然后就可以通過api模塊的getModel方法，獲取任意模塊的model的公開方法了。
3. getModel方法需要三個參數(shù)，分別是模塊名，方法名，然后是該方法的參數(shù)列表，key1=value1,key2=value2這種方式，多個參數(shù)之間用英文逗號隔開。

• 以調(diào)用bug模塊的getUserBugPairs()方法為例：

1. GET方式調(diào)用：

?m=api&f=getModel&module=bug&methodName=getUserBugPairs&params=account=$account

#PATH_INFO方式：api-getmodel-bug-getUserBugPairs-account=$account.json

API調(diào)用步驟

禪道的API調(diào)用共分為三個步驟：

1、獲得session。

• 首先要訪問api模塊的getSessionID方法，獲得session。

GET方式：?m=api&f=getSessionID&t=json
PATHINFO: api-getsessionid.json

返回的格式中包含sessionName和sessionID。在后續(xù)的訪問中，必須以cookie的方式，或者GET方式，將session傳遞給服務(wù)器。

2、驗證用戶身份。

• 然后可以訪問user模塊的login方法，來進行用戶身份的驗證。
• 用戶身份驗證，需要提供用戶名和密碼，以post方式傳遞給user-login方法。
• 變量名為： account, password。

3、調(diào)用相應(yīng)的API。

用戶驗證通過之后，就可以通過頁面調(diào)用的api，或者超級model調(diào)用的api來獲取相應(yīng)的數(shù)據(jù)了。

實際例子請參考，http://zentaoms.googlecode.com/svn/trunk/bin/getbugs.php執(zhí)行時，需要修改里面的相應(yīng)參數(shù)。

參考來源

• http://www.zentao.net/help-book-zentaopmshelp.html

ZenTaoPMS使用手冊導(dǎo)航

安裝： 安裝幫助|注冊帳號和應(yīng)用申請|初始化應(yīng)用|創(chuàng)建代碼版本下載SDK|通過SDK下載代碼|上傳禪道代碼|執(zhí)行禪道安裝程序|從BugFree升級到禪道|升級禪道 禪道結(jié)構(gòu)： 禪道的目錄結(jié)構(gòu)|通過禪道的請求代碼位置|禪道的數(shù)據(jù)庫結(jié)構(gòu)和common 配置禪道： 備份禪道|更新燃盡圖|配置email發(fā)信及超級管理員|修改禪道的語言提示|配置為靜態(tài)訪問|去掉訪問地址的zentao 使用： 個人管理 產(chǎn)品經(jīng)理： 維護產(chǎn)品及其模塊|建立計劃|需求管理|建立發(fā)布|路線圖|產(chǎn)品其他相關(guān)功能 項目經(jīng)理： 建立項目|組建團隊|確定需求|分解任務(wù)|項目進度|項目其他相關(guān)功能 開發(fā)團隊： 領(lǐng)取更新任務(wù)|創(chuàng)建build|提交測試任務(wù)|bug處理|開發(fā)團隊其他功能 測試團隊： 提交bug|驗證和維護bug|創(chuàng)建測試用例|管理測試任務(wù)|執(zhí)行用例并提交bug|查看報表統(tǒng)計|bug其他問題 管理員： 建立部門結(jié)構(gòu)|設(shè)置分組建立權(quán)限體系|維護公司信息|管理員其他使用 擴展禪道： 擴展機制簡介|命令行入口|API機制介紹|打包規(guī)范1.0版|在線擴展編輯幫助文檔|禪道插件實例 禪道FAQ