开放平台文档

# 1、如何申请API账号鉴权？

可以参考这篇文档指引：申请API账号 (opens new window)

# 2、为什么IDC域请求不通会报错超时呢？

因为TAPD部署在OA专用区，公司网络安全限制的原因，从 IDC 请求到 OA 会失败。可以参考下面的解决方法：

  1. 使用专用域名方式 oss.apiv2.tapd.woa.com：

curl -u 'xxxxxx:xx' 'http://oss.apiv2.tapd.woa.com/bugs?workspace_id=xxxx'

  1. 配置 hosts：idc域机器需要配置host
9.146.161.37 api.tapd.oa.com apiv2.tapd.oa.com
1

如果不方便配置Host，建议使用指定IP+Host头的方法：

curl -u 'xxxxxx:xx' -H 'Host: apiv2.tapd.oa.com' 'http://9.146.161.37/bugs?workspace_id=xxxx'

PS： 查看自己是不是IDC机器参考：https://iwiki.woa.com/tencent/static/iwiki-editor-pro/dist/preview.html?space=&page=1227785302&id=131410&name=6997554869969258912%281%29.MP4&size=1160018&language=zh (opens new window)

# 3、为什么我获取到数据和页面上的数量不一致呢？

在请求参数中加上limit控制返回结果数量最大值为200超过200时需要加上page参数进行翻页

# 4、如何上传附件

上传附件接口可参考文档：附件上传 (opens new window)

# 5、更新和创建接口的详细描述字段中怎么换行，还有超链接

可以在详细描述中使用前端的html标签如：br表示换行，a标签可用于链接，img标签可用于图片。 例如：

curl -u 'api_user:api_password' -d 'name=story_created_by_api&workspace_id=10158231&description=字段1<br>字段2' 'http://apiv2.tapd.oa.com/stories'
1

# 6、golang 如何在 idc 配置 apiv2 host头

Req.Host="XXXX" 123平台、IDC golang环境，可以这样： 地址替换成 http://9.146.161.37/ 。比如原来地址是 http://apiv2.tapd.oa.com/stoires ，要替换成 http://9.146.161.37/stories golang 配置 apiv2 header： Req.Host="apiv2.tapd.oa.com" 参考：https://www.cnblogs.com/jinsdu/p/5161962.html (opens new window)

# 7、接口中的模糊查询如何写？

特殊规则查询可以参考文档：使用必读 (opens new window)

# 8、api账号如何修改限制IP

开放平台注册账号可在应用后台-安全设置中添加或者删除

# 9、创建需求是否支持指定需求类别

支持，可以传 workitem_type_id=需求类别ID

# 10 、创建需求和缺陷是否可以指定模板

支持，需求的为 templated_id=模板ID，缺陷为 template_id=模板ID

# 11、通过API接口上传的图片为什么没有预览？

要设置正确的Content-Type才能正常预览。比如：Content-Type: image/png

# 12、API查询自定义字段的规则

目前自定义字段查询只支持全匹配值。

# 13、利用TAPD的api服务做报表、日报等，需要大量高频请求的场景应该怎么做

推荐使用数据本地化：就是用api+webhook增量来做优化。

  1. 先通过api全量获取一次数据存储到本地数据库中。
  2. 然后通过webhook做数据增量存储本地。webhook是可以及时回调数据到你们提供的地址上的。
  3. 数据在你们自己那边这样就不会有限流的情况了。

# 14、Python语言如何调用接口

Python建议是使用requests
库可参考文档：使用必读 (opens new window)

# 15、接口中时间类型的参数是否支持时分秒

目前是不支持时分秒的。只支持年月日查询

# 16、为什么API传数据必须要用长ID，不能用短ID吗？

因为数据库储存的ID是长ID，所以长ID是唯一ID。

# 17、API如何查询为空的数据

请求参数=null

# 18、API参数支持写入markdown或者富文本吗

不支持markdown
目前只支持富文本，可以用HTML标签

# 19、 api创建或更新的，不会触发系统配置的通知

目前api相关操作不会触发站内通知

# 20、idc访问apiv2需要走代理：

9.146.161.37 api.tapd.oa.com apiv2.tapd.oa.com
1

# 21、浏览器或者前端调用接口跨域导致访问失败：

不支持在前端或者浏览器访问请求TAPD api接口，会导致api账号和密码泄露风险。建议在后端服务器来请求TAPD api接口。

上次更新: 2023-11-20 15:29:39

← 更新日志 →