## 简介 🐕🐕

> 主要用于调用TAPD api v2 接口的SDK<(￣︶￣)↗[GO!]

> 推荐版本: NodeJs 14.13.0+

## Install
设置npm工具使用软件源的registry
```
npm config set registry https://mirrors.tencent.com/npm/
```
安装SDK包
```
npm install @tencent/tapd-node-sdk
```

## Usage

#### 申请应用
1. 申请和使用应用
https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E5%BA%94%E7%94%A8API%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95.html

2. 复制应用ID和密钥
https://o.tapd.woa.com/admin/{你的应用标识}/dashboard
![Alt](https://o.tapd.woa.com/document/img/tapd_20417300_1638862843_15.png)

 
#### DEMO
```javascript
const SDK = require('@tencent/tapd-node-sdk');




const api = new SDK({
    client: 'gggg123', // 你的应用CODE
    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
});


// api 详细文档可参考tapdAPI的文档
api.getStories({
    workspace_id: '755'
}).then(data => {
    console.log(data);
}).catch(e => console.log(e)); 

// 文件上传接口使用方式
var file = fs.createReadStream('your file path')

// 支持Buffer
// const {FILE}= require('@tencent/tapd-node-sdk');
// const { Readable } = require('stream');
// //Readable
// const file_stdout = Readable.from(bitmap);
// var file = new FILE({
//   stdout: file_stdout,
//   filename: 'test.jpg',
// });

api.uploadImage({
    workspace_id: "755", 
    image: file
}).then(data => {
    console.log(data);
}).catch(e => console.log(e));


api.uploadImage({
    workspace_id: "755", 
    image: file
}).then(data => {
    console.log(data);
}).catch(e => console.log(e));
```

#### [查看所有SDK方法和参数](https://o.tapd.woa.com/document/api-doc/API%E6%96%87%E6%A1%A3/api_reference/)

#### IDC 网络的使用
1. 怎看自己是不是IDC网络, 查看这个[链接](https://iwiki.woa.com/tencent/static/iwiki-editor-pro/dist/preview.html?space=&page=1227785302&id=131410&name=6997554869969258912(1).MP4&size=1160018&language=zh)

2. 如果是IDC网络怎么设置
```javascript
const SDK = require('@tencent/tapd-node-sdk');

const api = new SDK({
    client: 'gggg123', // 你的应用CODE
    secret: '112A5B9F-D7B9-EC9C-B688-24E44F5043C4', // 密钥 注意保密
    env: 'idc'
});

```


## Artifact
 https://mirrors.tencent.com/#/private/npm/detail?repo_id=537&project_name=%40tencent%2Ftapd-node-sdk&search_label=package_name&search_value=tapd-node-sdk&page_num=1

## 其他问题

提issue可能看不到，找tapd客服解决反馈。

## Contributions
欢迎参与SDK共建！开发&共建流程，请参照 [contributing.md](https://git.woa.com/tapd-plugin-core/tplugin-sdk/blob/dev/CONTRIBUTING.md)。