tplugin通过SDK的方式,向插件中暴露了一批操作TAPD系统的接口。开发者可以在插件中很方便的直接调用TAPD接口,不需要额外关注接口的封装和健全等。
# SDK使用
Python:
from tapdplugin import sdk
tapd = sdk.instance()
tapd.get_stories_count({workspace_id:755})
1
2
3
2
3
NodeJs:
const { tapdSdk } = require('@tencent/tplugin-core');
tapdSdk.getStoriesCount({'workspace_id': 755}).then(data => {
console.log(data)
}).catch(e => {
console.log(e)
})
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 数据权限
sdk提供了基于项目态的权限控制,对开发者提供了,所有已经授权给该插件的接口权限。
# 授权接口
开发者需要在plugin.yaml
中声明需要,插件需要使用的权限范围,每个权限范围对应这一批开放的接口。
scopes:
- story #需求读和写相关接口
- bug#read #缺陷读类型接口
1
2
3
2
3
所有的scope列表,已经对应的接口列表,可以参考API接口文档
# 授权项目
对所有已经安装了插件的项目,插件都有对应的接口操作权限。
需要注意的是,每个项目安装的插件版本可能不同,对于特定某个安装项目,所拥有的接口范围,取决去安装版本中声明的scope。
可以前往 「开放平台-应用管理后台-应用权限」 查看。
也可以查看插件版本库中,对应版本的配置文件plugin.yaml
。