Mendix - 腾讯文档API连接器介绍及使用说明
hankx
2021.10.14 10:30发布于Mendix组件库
730

Tencent Document Connector 腾讯文档连接器使用说明

简介

Tencent Document Connector (以下简称TDC)是一个Mendix 模块, 其实现了腾讯文档API的认证、调用等通用流程。在添加该模块后,可以很方便在自己的Mendix应用中使用腾讯文档的API。
 

依赖

安装

下载包后导入到自己项目即可。若项目还没有安装以上依赖包,则需要同时安装,在应用市场搜索依赖名称,下载后导入。

配置

首先需要将 Encryption 和DeepLink 两个模块配置好才能进入TDC的配置流程。这两个模块都有自己官方的配置文档(英文), 这里做简单说明。
Encryption
该模块主要用于将调用API需要存储和使用的Client ID, Client Secret等敏感信息加密存储和在使用时候解密。
需要配置几个常量,这几个常量都在 Private - String en/de-cryption 下面。可以使用在线随机字符工具来生成需要用到的加密密钥。
  • EncryptionKey, 32位随机字符,例如 AnupLvuqbZRf3cK6jdnWlIppB1QoV3b7
  • LegacyEncryptionKey 16位随机字符, 例如 dK2Zm1CDzZA1akTc
  • EncryptionPrefix 保持默认的 {AES3} 不变
  •  

qg-lA2Rk.png


DeepLink
该模块是Mendix 的前端路由库。主要用于让Mendix前端应用可以针对不同的URL path 调用不同的Microflow(微流)。因为Mendix应用的前端都是单页应用。DeepLink的作用类似于Vue 的 vue-router, react 的 React Router 等前端框架的路由库。
  1. 设置 DeepLink.Startdeeplink 为启动微流, 方法是在 App > Settings > Server > After startup 中选中这个微流。如果你已经设置了其他的微流,则需要将 Startdeeplink 设置为启动微流的子微流

trTuDzxw.png


  1. 在导航中添加一个新导航项目, 设置点击后调用 DeepLink.DeepLinkConfigurationOverview。若项目开启了安全设置,请设置此当导航为仅管理员或者同等级别的用户可访问

hCMPQWqo.png


  1. 新建一个微流:
    • 第一步调用 Deeplink.DeeplinkHome。
    • 添加一个条件判断:
      • DeeplinkHome 的结果是 true , 则直接结束微流
      • 若结果是 false ,则添加一个 show page 的 Activity,跳转到你的应用默认首页。
      • 最后结束微流
      • 示例微流如下
  •  

tnAMj3yY.png


  1. 启动应用。若启用了安全设置,以管理员身份进入步骤 2 配置好的DeepLink配置页面。
    • 在页面中点击 new, 路径为 callback, 选择 TDC 中的 RedirectHandler 微流。
    • 勾选 Include GET parametersSeparate GET parameters
    • 保存结束, 如图
  •  

MVZUqwpA.png


  •  
配置 TDC
  1. 在导航中新建一个导航项目,若开启了安全配置,请制定管理员或同等安全级别的用户访问。导航点击事件为调用 TDC 的 微流 QDocAUth.QDoc_SetUp 

Mydi3GNA.png


  1. 重启应用,进入步骤 1 配置好的页面
 

zcYQTb-g.png


  1. 点击新增,填入在腾讯文档中申请好的 client idclient secretapp name 可以随意。点击保存。

tEQ9gQnk.png


  1. 点击 get auth 将进入腾讯文档标准认证流程,用户需要使用微信或者qq扫描二维码来允许你创建的应用访问并操作其腾讯文档。
 

ICvPnaLg.png


若认证成功,页面会多出 list my docs 按钮,点击可以列出用户腾讯文档中默认目录下的文档。页面也有新增按钮,点击填写必要信息后,可在用户腾讯文档中新增一个文件。这两个操作为调用示例。

XsrKrYnY.png


 
  1. 在实际使用中,一旦认证成功,会将认证用户的 access_token, refresh_token 保存在数据库中。若要实现其他功能,只需要根据腾讯文档API,添加新的 Mendix 页面和微流即可,调用的流程可参考步骤 5 中的相应页面、微流。
Andes_云龙
点赞
收藏
手机查看
举报
0个评论
倒序看帖
仅看楼主

暂无数据