看完必恍然大悟的活字格内幕：四十九、如何对接活字格的接口

leilei6120

本帖最后由 Erik.Xue 于 2024-12-16 15:27 编辑

接口，相信各位大佬们一定很熟悉的说。活字格作为一款开放性十足的低代码平台，当然也少不了接口的对接啦。因为毕竟任何系统对接活字格都是很有可能的。那么我们今天就来讲一讲如何调用活字格的接口，来实现活字格自定义接口的对接。

我们先来复习一下什么是软件接口？

接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。

说人话，就是每个系统都是独立的个体，如果想让不同的系统之间有数据的交互，那么接口就像是要给系统开个门，要想从我的系统中获取数据或者发送请求，那么就要从我专门开的门进——接口，进入才可以。

活字格作为一款可以生产系统的工具，当然也会提供给各位对接接口的机会。接下来就为大家介绍如果在活字格中进行接口的创建和对接。

方式一：服务端命令（活字格调用第三方系统的接口）
由于我们没有现成的第三方系统，那么我就用活字格来模拟一个第三方的系统。该系统中提供一个向表格存储数据的接口。

由于活字格目前暂时不支持Oauth2认证，所以为了验证请求接口的调用者身份，目前可以使用和第三方约定一个类似于key的参数，以此key来判断访问接口人的身份。
这里模拟的第三方系统要验证的key为balabala，那么在第三方系统中就需要判断请求过来的参数中是否有key=balabla的参数，有的话再执行相应操作，否则不予执行。

为了模拟以上描述的效果，我就在服务端命令中使用条件命令判断key参数，如图：
image.png313030394.png

创建好这个服务端命令，就相当于对外暴露出了一个接口，而接口请求地址就是服务端命令中名称下的url。
image.png379950866.png

接口名：addData
HTTP Verb：POST
URL：http://xa-hzg-erik:8080/AAA/ServerCommand/openApi
Request Body：

{
"openApi": [
{
"secretKey": "balabala",
"msg"?: "xxxxx",
}
}

复制代码

有了这个接口，我们就可以借助我们的发送HTTP请求命令向这个接口发送对应的数据了。

这里要注意的是，如果直接在单元格命令上使用发送HTTP请求命令的话，这样是存在跨域的问题的，如图：
image.png41058348.png

为了避免跨域的问题，我们需要在服务端命令里面使用发送HTTP请求命令，以防止跨域问题的发生。

那么我们在工程中新建一个服务端命令，根据接口要求，我们需要发送secretKey和msg两个参数，配置如下图：
image.png489259337.png

命令配置：

可以设置返回结果：
image.png291640013.png

配置好服务端命令后，在页面上调用该服务端命令测试一下：
image.png200307921.png

请求发送成功了~！

我们再看下模拟的第三方网站是否执行了请求：
image.png15256957.png

可以看到，我们的请求已经执行成功，第三方网站已经将数据成功存入数据表中。

服务端命令（第三方系统调用活字格开放的接口）
这个就很简单了，只要在活字格系统中创建自定义的服务端命令后，服务端命令名称下对应的url就是活字格提供的接口地址。
image.png913713378.png

上面也告知了大家，目前活字格暂时不支持Oauth2认证，为了确认身份，可以约定一个key参数的办法，进行身份的验证即可。
方式二：写WebApi的方式生成接口

这种方式一般针对与复杂的接口逻辑功能，比如想通过代码的方式实现token认证等方式，那么就需要借助此方法实现。

这里的话，为大家演示一下，如果使用WebApi的方式向表格中添加数据。

如何进行服务端编程呢？具体的步骤可以参考我们的帮助文档：
https://help.grapecity.com.cn/pa ... ion?pageId=53350185

我们在这里简单的做一个向表格中添加数据表数据的服务端WebApi：
image.png204447020.png