1.概述
1.1 WEBAPI说明
WEBAPI:通过http协议连接访问特定的webAPI接口服务,Web服务器处理这些请求,然后返回响应。响应的格式通常是JSON或XML。
REST:Representational State Transfer 表述性状态传递。REST可能是现在最流行的一种Web API。
RPC:Remote Procedure Call。RPC是一种比较简单的API,客户端直接会执行另一个服务器上的代码。
GraphQL:GraphQL 是 API的查询语言,Facebook开发。
1.2 注意点
OurwayBI : 要求返回标准JSON 格式。
1.3 难点与应对
难点:每一个webAPI调用的参数都是不同的,有不同的调用方式。
应对: 一定要向WEBAPI提供者取得相关API相关说明文档,并对每一个接口进行测试。
1.4 调用WEBAPI
WEBAPI 的调用方法:
1、用或不用密钥
2、每次访问时带上固定密钥。
3、每次访问均先要用密钥生成动态的token,然后通过token验试访问的合法性。
前端使用用户名/密码向服务端请求认证,服务端认证成功,那么在服务端会返回 Token 给前端。前端可以在每次请求的时候带上 Token 证明请求的合法地位。
1.5 固定密钥
云屋会议:http://www.cloudroom.com/crdoc/confapi/
2.操作步骤
操作流程图:
2.1 取得公共参数
2.2 取得接口参数
2.3 取得参数StartTmie
http://tool.chinaz.com/Tools/unixtime.aspx
2.4 WEBAPI分页参数
2.5 Postman测试API
2.6 建立OurwayBI连接
2.7 添加API
2.8 手工建立StartTime
function() {var v_date = new Date().setMonth((new Date().getMonth()-1));
return v_date ;
}
2.9 对应内置变量
?Limit? 的大小由数据流任务中的每批行数据制确定。
2.10 设定数据读取路径
2.11 通过数据流任务抽取数据
3.Token访问
每次访问时需先用密钥生成token,然后每次访问API时均要使用token进行身份认证。
3.1 取得API说明
金蝶云之家
https://open.yunzhijia.com/openplatform/resourceCenter/doc#/gitbook-wiki/server-api/accessToken.html
3.2 测试API可用性
3.3 在数据源设置token
3.4 添加并测试API
https://open.yunzhijia.com/openplatform/resourceCenter/doc#/gitbook-wiki/erp-api/erpPerson.html
3.5 MYSQL分页机制
SELECT update ,name, answer FROM syncAnswerData where fupdate >’2020-03-21’ LIMIT 10 OFFSET 0;
解释:
“0”: 代表数据获取的起始位置.(0代表第一条记录,以此递增)
“10”: 期望获取的记录条数.
3.6 添加API
参数 | 参数说明 | 对应ourwayBI参数 |
begin | 计数下标,默认0 | ?offset? |
count | 计数基数,默认1000 | ?limit? |