External API

动机

• TAPD中的成员列表信息有时候和公司的管理是不同步的，比如离职人员没有及时标记为离职状态。
• External API可以通过自定义的API，调整TAPD助手在一些页面的特性。

功能

• 在设置页面的 “外部API” 填入URL，并保存

成员列表页面标签

• 进入TAPD “成员列表” 页面，插件会请求在设置页保存的API {api: 'user-info'}
• 根据Response中Tags，在成员列表展示标签（例如：打上 “离职” Tag）

API规范

• POST BODY JSON

{
  api: 'user-info',
  data: {
    users: [
      {
        nick: '',
        name: '',
        email: '',
        department: '',
        group: '',
        status: ''
      }
    ]
}

• Response

{
  code: 0,
  message: 'blabla',
  data: {
    users: [
      {
        nick: '', // used as unique key
        // name: '',
        // email: '',
        // department: '',
        // group: '',
        // status: '',
        tags: [
          {
            name: '离职', // tag name
            value: 'leave',
            style: {  // tag css style
              fontSize: '10px',
              color: 'white',
              backgroundColor: 'green'
            },
            rowStyle: { // change row css style
              backgroundColor: "rgba(0, 255, 0, 0.2)"
            }
          }
          // ... other tags
        ]
      }
    ]
  }
}

External API test URL (用于测试)

https://platform-179306.appspot.com/tapd-assist-external-api-test (位于GAE，需要翻墙)

在TAPD助手中测试会提交贵公司数据，我们承诺不会搜集记录这些数据。