• 最新功能
  • 1 EXCEL服务器概述
  • 2 安装与卸载
  • 3 基本概念&基本操作
  • 4 建立部门、角色、用户
  • 5 建立基础数据
  • 6 管理业务数据
  • 7 熟练填报
  • 8 数据查询
  • 9 工作流
  • 10 回写公式
  • 11 统计报表
  • 12 应用系统管理
  • 13 系统管理模块的常用操作
  • 14 填报网站
  • 15 移动端应用
  • 16 系统外观设计
  • 17 模板管理
  • 18 角色和用户
  • 19 数据项、数据表、数据库
  • 20 数据规范详解
  • 21 工作流详解
  • 22 表间公式详解
  • 23 实时系统、实时管理
  • 24 即时通讯
  • 25 文档管理
  • 26 网盘
  • 27 和其它系统的数据集成
  • 28 和CAD软件的集成
  • 29 与移动端其它应用的集成
  • 30 安装与部署的高级话题
  • 31 表达式函数详解
  • 32 通过VBA程序操纵EXCEL服务器
  • 33 通过命令行操作ES客户端
  • 34 商业智能BI系统
  • 35 WebApi的应用
  • 35.1 Excel服务器调用第三方WebApi
  • 35.1.1 通过WebApi提取数据
  • 35.1.2 通过WebApi更新数据
  • 35.1.3 WebApi详解
  • 35.2 Excel服务器的WebApi对外接口
  • 36 共享文档
上一节 下一节

35.1.3 WebApi详解

第三方Api文档与WebApi的属性关系

WebApi的全部属性需要在第三方Api文档中获取。

以下举例说明如何依照Api文档,定义一个WebApi:

例子1:

文档地址:https://docs.ekuaibao.com/docs/open-api/dimensions/batch-creat-dimension-items





例子2:
 文档地址:https://open.dingtalk.com/document/orgapp-server/intelligent-personnel-query-the-list-of-on-the-job-employees-of-the
 




 


例子3:
 文档地址:https://developer.work.weixin.qq.com/document/path/91039
 


 WebApi查询公式、调用公式的区别  

相同点:

组织请求数据后,调用定义好的WebApi,向第三方发送数据,然后把返回数据存储到ES的数据表中,二者都可以实现此功能。

不同点:

1. 查询公式算提数公式,除了会把Api接口返回的数据存储到ES数据表中,还可以往本报表填充,执行时机等属性与普通提数公式类似,多用于查询类的Api接口。

2. 调用算回写公式,一般用于第三方的增、删、改Api接口,执行时机等属性与回写公式类似。


几个常见使用实例

token的获取及使用方法

文档地址:https://open.dingtalk.com/document/orgapp-server/obtain-orgapp-token

WebApi定义:(完全按照接口文档定义的WebApi)

1、 基本信息

2、请求参数  

3、返回参数  


表间公式定义(指定接口的调用方式):
 公式1:在模板【在职员工列表】中定义一个WebApi 查询公式:
 


公式2:在模板【在职员工列表】中定义一个提数公式:


公式3:在模板【在职员工列表】中定义一个WebApi 查询公式:


定义过程分析:
 公式3调用的WebApi需要使用token,而token要每两个小时获取一次,不能频繁获取。公式1 的作用是每隔两个小时,把最新的token刷新到ES中的数据表,公式2的作用是从ES数据表中获取最新的token供公式3使用。这3个公式应认为是一个组合,需要执行公式3时,需先执行公式1和公式2,才能保证token的正确性。
 

第三方数据要求分页提取,利用筛选条件改变后的时机,多次调用

文档地址:https://open.dingtalk.com/document/orgapp-server/intelligent-personnel-query-the-list-of-on-the-job-employees-of-the
     WebApi定义:(完全按照接口文档定义的WebApi)





模板中的辅助字段


表间公式定义:
 •执行时机勾选“筛选条件改变后”


定义过程分析:



请先看一下上面两个图,Body参数中的offset、size参数,返回参数中的next_list参数的说明。
 公式设置为新建打开时和筛选条件改变后执行,在新建打开后,第一次执行时传递的参数offset=0,size=50,假设返回结果中的next_list为50,这个 “50”填充到了模板的辅助字段,触发了第二次执行并满足执行条件,传递的参数offset=50,size=50,假设返回结果中的next_list为100,这个 “100”填充到了模板的辅助字段,触发了第三次执行并满足执行条件,传递的参数offset=100,size=50,假设返回结果中的next_list为空,这个“空”被条件取值替换成了-1填充到了模板的辅助字段,触发了第四次执行并不满足执行条件,执行停止。

关于加密算法和一些函数的使用

文档地址:https://cloud.tencent.com/document/product/1095/42413#.E5.85.AC.E5.85.B1.E5.8F.82.E6.95.B0
     WebApi定义:(完全按照接口文档定义的WebApi)



文档中要求的请求头参数(只列举了必填参数)


公式中为上述请求头参数赋值
     


1、固定值,可不填,参照前文。
 2、在开放平台中获取,此处存到了一个模板中,防泄露。
 3、Unix时间戳,在另外一个提数公式由函数获得,填充到了本报表,再由本报表赋值给请求头。执行了获取时间戳的公式后,超过5分钟再调用此WebApi会引起签名错误(Api文档中有说明)。


4、随机正整数,利用Excel函数


5、Api文档中的加密说明如下:



对应公式中的设置方法:


6、在开放平台中获取,此处存到了一个模板中,防泄露。
 7、固定值。

上一节 下一节