api机制简介

2014-09-01 18:20:22
王春生
51193
最后编辑:石洋洋 于 2019-01-15 13:33:21
分享链接
摘要:zentaoPHP还提供了API机制,方便大家来和其他的系统进行集成。

一、API机制介绍:

前面章节讲述的扩展机制是需要直接开发PHP或者html, css, js等代码。zentaoPHP还提供了API机制,方便大家来和其他的系统进行集成。

API机制都是基于http协议的。返回的数据以json格式存储。

zentaoPHP架共实现了两种API机制。一种为直接的页面调用,一种通过超级model调用接口,直接调用model层的方法,下面我们一一来看下。

二、页面直接调用

当你访问使用zentaoPHP开发的页面时,将访问的url地址中的html换成json,得到的就是json格式的数据。

比如http://pms.zentao.net/project-task-8.html,返回的网页格式,把后面的.html改成.json,返回的是什么?对了,返回的是json格式的数据。

如果是GET 方式,那么只需要将t参数改成json,http://pms.zentao.net/?m=project&f=task&t=json。


返回的数据是做了两次json_encode,下面是代码的示例:

$result = file_get_contents('http://pms.zentao.net/project-task-8.json'); 
$result = json_decode($result);
if($result->status == 'success' and md5($result->data) == $result->md5)
{
    $data = json_decode($result->data);
    print_r($data);
}

先判断第一层里面的result是否正确,md5签名是否正确,然后再对data对象进行json_decode。

1.2.2 超级model调用接口

页面的调用,存在一定的局限,比如返回的数据可能没有你想要的,或者返回了你不需要的数据。为此,我们特地准备了一个超级model调用接口。该接口的使用方式:


首先要为相应的帐号增加超级model调用接口的访问权限。

然后就可以通过api模块的getModel方法,获取任意模块的model的公开方法了。

getModel方法需要三个参数,分别是模块名,方法名,然后是该方法的参数列表,key1=value1,key2=value2这种方式,多个参数之间用英文逗号隔开。


以调用bug模块的getUserBugPairs()方法为例:

GET方式调用: ?m=api&f=getModel&module=bug&methodName=getUserBugPairs&params=account=$account

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

备注:

超级model调用方法暂时只有禅道项目管理软件实现。蝉知门户和然之协同暂时还没有实现。

评论列表
hUI雪峰 2020-12-21 19:03:30
请问外部调用接口应该怎么写 我添加sessionName+'='+sessionID以后也请求不到
王春生 2020-12-23 08:51:24
sessionname要替换成具体的cookie变量的名字,sessionid换成实际的cookie的值。这个根据getconfig接口返回的值定。
zl 2020-11-24 14:18:29
好的,谢谢
zl 2020-11-23 09:29:55
用户列表已经取出来了,但是批量提娜佳保存的时候,像单挑添加那样把抄送人传回去没用,请问批量添加任务接口后台有接收抄送人这个字段吗?
王春生 2020-11-24 08:13:36
没有。可以一个个创建。
zl 2020-11-24 14:19:13
好的,谢谢
zl 2020-11-19 16:28:14
请问批量添加任务接口,抄送人那个字段该怎么传参呢?
王春生 2020-11-23 08:44:47
用户名列表。
doctor 2020-11-13 16:01:41
/zentao/api-getmodel-bug-view-bugID=46.json,超级model调用api,结果为{"data":"null","status":"fail","md5":"37a6259cc0c1dae299a7866489dff0bd"},可能原因是什么呢
王春生 2020-11-16 09:09:52
getmodel的参数不对,请参照文档检查。
syl 2020-12-20 15:18:23
请问下介绍超级model api的文档在哪里呀,找了一圈好像没有
王春生 2020-12-23 08:52:01
就是在这篇文章里面啊。
飘摇 2020-05-30 17:26:48
/zentao/backup-delete-[fileName]-[confirm].json
这个借口怎么调?
飘摇 2020-06-02 17:15:29
这个接口,我调通了,但就是header里的这个zentaosid,还不知道可以从哪个接口获取
王春生 2020-06-03 09:53:47
index.php?mode=getconfig
zw 2020-04-28 14:14:49
我可以外部提交bug到禅道上 绕过登录验证这一项吗
111 2020-02-26 11:28:57
看不懂 给个完整postman 调用的例子么
pauli 2020-02-13 10:29:52
能给一个完成的禅道 API 列表吗?@王春生
王春生 2020-02-13 20:09:36
后台二次开发里面列出来的是所有的api列表。
秦时明月 2020-01-08 18:50:23
参数如果是float类型,含有小数点的话,小数点后的参数获取不到,请问怎么解决呢?
王春生 2020-01-13 09:55:33
编码之后传输。
1/6
发表评论
评论通过审核后显示。