編輯“ZenTaoPMS/API機(jī)制介紹”（章節(jié)）

==API機(jī)制介紹==

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

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

===頁面的調(diào)用===

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

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

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

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

*以調(diào)用bug模塊的getUserBugPairs()方法為例：
#GET方式調(diào)用： 

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

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

</pre>

===API調(diào)用步驟===

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

1、獲得session。

*首先要訪問api模塊的getSessionID方法，獲得session。
<pre>
GET方式：?m=api&f=getSessionID&t=json
PATHINFO: api-getsessionid.json
</pre>

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

2、驗(yàn)證用戶身份。

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

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

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

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