连接类型向导化实现WebAPI登记和鉴权
1 开发环境准备
苍穹版本:2024-01-26 V6.0.6(BIZ)
说明:API文档分为两部分,获取系统token和获取系统人员,这个API我是在mock服务器上搭建的,数据无意义只是模拟调用供演示使用。
2 开发流程
首先使用postman开发登记,根据获取token部分,我们可以根据文档在postman中配置如下调用请求,取出cURL命令。
curl --location 'https://mockapi.kingdee.com/api/v1/autn/token' \ --header 'Content-Type: application/json' \ --data '{ "username": "admin", "password": "password123" } '
提前看下调用的API是如何使用token认证,并且如何获取失效时间的,按照文档中的获取人员信息和组织信息,使用的是Bearer 认证,token失效时间在expires_in中,单位是秒,这步很重要,后面会讲为什么要提前看。
我们讲cURL命令复制,打开集成管理-连接管理-连接类型-向导新增按钮,创建WebAPI按钮可以勾选,本次演示我为了方便后续使用者,就独立出来。
点击下一步粘贴刚才生成的cURL命令,点击转换
此时我们要根据URL参数,请求头,请求体的实际内容做好分录配置,比如有的获取token有url参数,那就要切换到对应的页签,样例中我们切换到请求体,然后调整参数。
这里介绍下几个复选框的含义,在连接配置中配置,一遍表示可变参数,比如登录的人员不同,uat和生产的账户不同,参数作为默认值,参数就会默认带入连接配置中,按需修改即可,必填则表示在连接配置中参数必须配置,参数值作为密码,表示数据在前端不可见展示,用户配置连接时需要重新输入。
样例中,请求体的两个参数则会按照以下语义配置,请求头则不配置分录,直接在脚本中使用默认值。实际的API大家按需调整请求头和URL参数。
重点,由于后续的接口API(获取人员信息和组织信息),token的使用并不是直接用的获取token的默认值,而是使用Bearer认证,并且刷新时间在token的data返回值中,因此我们要调整脚本。
打开脚本模式,修改脚本的刷新时间(一般建议调整到token失效前的300*1000毫秒左右)和组装新的token,由于样例中返回的access_token需要Bearer认证,因此手动组装一个新的$token来承接,如果实际的调用API不需要对token额外处理时可以直接使用请求返回的内容。
填写好编码名称,点击测试后可以查看请求token的结构,然后进入下一步,响应体的内容在后续WebAPI调用中会使用。
刷新脚本就是重新获取token的脚本,绝大部分场景都是一致勾选开关即可,如果有不一致的场景,则重复登录脚本的过程。
保存后下一步创建连接配置,填写编码,名称,密码字段,保存后进入下一步。
创建数据源后,保存即完成了连接器的创建。
下一步登记WebAPI,还是先在postman调通。
curl --location 'https://mockapi.kingdee.com/api/v1/user-info' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJjb21wYW55SWQiOjEwMCwidXNlcl9pZCI6MTIwLCJkZXB0SWQiOjEwMCwidXNlcl9rZXkiOiI5NjFhMjQ5NC1kOTkwLTQzNjgtOTdhMi1iNDJhYWRjZTk4NWMiLCJkZXB0VHlwZSI6ImNvbXBhbnkiLCJ1c2VybmFtZSI6ImppdXNoZW4ifQ.Ud1BVu3ZiPi_Q8VEXScJALBufMrOqDDeujpj90VbZzEwNt9CJ8VvhqJnBD3Ze3hdrapcvY_ojKlGdxnqu1F5rw'
进入集成管理-API集成-WebAPI登记,新增下拉按钮-curl导入
粘贴刚刚复制的WebAPI的cURL命令后解析,绑定向导创建的数据源
检查URL参数分录、请求头分录、请求体分录,双击分录框选择对应的值,样例中选择连接类型中的$session.$token,在某些不处理token的变量中选择的就是$session.data.access_token。【这里额外解释下,如果WebAPI有一些请求是固定值并且需要加密或者支持配置,我们可以在对应的连接类型的分录上增加字段,这些字段就会在连接配置中出现,然后在WebAPI中我们选择$connnection的属性即可引用对应的值,对于一些无需登录的WebAPI,我们可以在连接类型中创建空的登录脚本,只登记自己需要的字段,然后在WebAPI中引用】
保存启用后测试。
连接类型向导化实现WebAPI登记和鉴权
本文2024-09-23 00:47:42发表“云苍穹知识”栏目。
本文链接:https://wenku.my7c.com/article/kingdee-cangqiong-141784.html
- 鼎捷EAI整合規範文件V3.1.07 (集團).pdf
- 鼎捷OpenAPI應用場景說明_基礎資料.pdf
- 鼎捷OpenAPI應用場景說明_財務管理.pdf
- 鼎捷T100 API設計器使用手冊T100 APIDesigner(V1.0).docx
- 鼎新e-GoB2雲端ERP B2 線上課程E6-2應付票據整批郵寄 領取.pdf
- 鼎新e-GoB2雲端ERP B2 線上課程A4使用者建立權限設定.pdf
- 鼎新e-GoB2雲端ERP B2 線上課程C3會計開帳與會計傳票.pdf
- 鼎新e-GoB2雲端ERP B2 線上課程E6-1應付票據.pdf
- 鼎新e-GoB2雲端ERP B2 線上課程A5-1進銷存參數設定(初階篇).pdf
- 鼎新e-GoB2雲端ERP B2 線上課程D2帳款開帳與票據開帳.pdf