配置使用与常见问题 分享链接/book/api/1397.html

一、禅道版本要求

禅道 RESTful API v1 在禅道开源版 16.5 版本之后新增到禅道框架中，API 入口文件位于【禅道项目目录/www/api.php】，API 的路由解析规则位于【禅道项目目录/config/routes.php】

二、使用说明与示例

 2.1以获取1号产品的bug列表举例

（1）保证账号有查看1号产品的bug访问权限（权限调整可以在后台-人员管理-权限中进行调整，具体可以参考文档 https://www.zentao.net/book/zentaopms/1010.html）

（2）请求 zentaourl/api.php/v1/tokens 接口获取 token，以 curl 命令举例如下，Header 中设定 Content-Type 为 application/json ，data 中设定用户对应的 account  和 password

curl -X POST "zentaourl/api.php/v1/tokens" -H "Content-Type: application/json" -d '{"account": "admin", "password": "adminpassword"}'

获得返回结果举例如下：

{"token":"xxxxx62e16b45kndlxxxxx"}

 2.2使用返回的 token 获取1号产品的 bug 列表

请求其他接口时（非tokens接口），需要在 Header 中添加一个名为 Token 的键，其值为你刚刚获取的 token，以获取产品ID为1的bug列表举例，curl 命令如下

curl -X GET "zentaourl/api.php/v1/products/1/bugs" -H "Token: xxxxx62e16b45kndlxxxxx" -H "Content-Type: application/json"

获得的结果举例如下：

{"page":1,"total":0,"limit":20,"bugs":[]}

三、常见问题

 3.1返回 error:not found

{"error":"not found"}