首页 搜索 关于
ivx编辑器通信组件:API组件
ivx编辑器通信组件:API组件
November  2  2021 学习 Admin

API(Application Programming Interface 应用程序编程接口)是一些预先定义、开发好的函数,允许通过接口的方式与外部进行数据通信,使得外部人员无需访问源码或理解内部工作机制即可调用该函数或硬件。

API组件

举例说明,比如通过Camara API,可以访问设备摄像头或调用相册中存储的图片;通过FullScreen API 可以向用户请求全屏显示,并退出全屏状态。

除了调用硬件API接口,在应用开发中我们需要经常使用数据API。数据API可能来源于自行开发的外部函数,也可以直接调用一些由其他平台运营的商用API服务,以获取一些常规数据,例如,天气预报、地理位置查询、手机号码归属地等。

iVX 提供了便捷易用的API组件,包括前台API和后台API两种类型,允许我们调用API并接收返回数据。下图依次为前台API和后台API:


API的三要素

通常情况下,当我们拥有了一个API的调用权限后,商用API都会提供完整的调用文档,比如聚合数据上提供的手机号归属地查询的接口地址:

https://www.juhe.cn/docs/api/id/11

一个完整的API文档可能包含很多复杂的信息,但我们只需要关注三个要素:请求地址与方式、接收参数和返回参数。原理和调用服务一样,需要给服务传入一些接收参数,再处理返回的结果。

1、请求地址与方式
请求地址即API的接口地址,只有通过这个URL地址,我们才能找到这个API。除了URL地址,
大多数API在请求时还规定了请求的方法,包括get、post、delete和put
聚合数据上手机号归属地查询的请求地址和请求方式如下图:

2、接收参数
接收参数也经常被称为“请求参数”,即我们在请求API的时候需要带上的信息,和服务的接收参数类似。聚合数据上手机号归属地查询的接收参数如下图:

以上参数的意义是:当我们在调用这个API时,需要告诉这个API我们要查询的手机号是什么,以及我们申请的key。这个key是自己去平台申请的,平台会根据这个key来对API服务进行限制和扣费。另外,还有一个非必填的参数“dtype”,可以声明返回的格式,不填它也不会影响返回结果。

3、返回参数
返回参数即这个API收到请求后返回的结果:

由上图的返回参数说明表可以得知:这个API会返回省份,城市,区号等信息。另外,大多数API都会返回一个错误码(返回码)以及错误说明,来标记这个API调用出错的情况,比如:超出每日允许使用次数的限制,或者手机号格式不正确等。

API的调试

1、API的属性
在前台或后台添加好一个API组件,选中该组件后可以看到左侧的属性栏:

2、API的调试

设置接口地址和调用方法
根据已有的接口文档说明,设置接口地址,确认调用方法和请求类型
填入API的URL地址:http://apis.juhe.cn/mobile/get
下拉选择调用方法:get

设置接收参数(请求参数)
接收参数,分为header参数和body参数。header参数不经常使用,在这里就不再赘述了,大多数情况下,我们只需要添加body参数。这个API需要设置的接收参数为phone和key:

也可以直接复制粘贴JSON格式的body,如下的JSON对象会被解析成和上方一样的内容:

注意:key是需要自己去申请的,同时,申请好key后要注意保密,以防造成不必要的损失。

返回参数:
执行完以上两个操作后,就该到了调试阶段。点击属性栏中的调试按钮,下方就会返回API的调试结果:

收到返回结果后,可以点击右下方的“保存结果结构”按钮,系统就会自动将返回的结果解析为JSON结构:

这个结构解析功能和通用变量是类似的,这个解析的结果在我们之后使用API信息的时候会帮助我们快速的找到我们需要的内容。
关于JSON结构解析,我们可以具体参考通用变量组件。
最后来比较一下解析出来的结果与API文档上的说明:

我们会发现,相比文档,API的真实返回结果多了两个参数,resultcode和card,这是很正常的现象,我们在使用第三方API的时候经常会遇到真实返回结果和文档不一致的情况,因为文档没有办法保证实时更新。因此,我们在使用任何API的时候,都不要百分之百依赖文档,而要相信自己调试出来的结果。

API的使用

1、前台调用API

完成API的调试后,就可以添加事件动作去调用调试好的API。这里的逻辑是在点击按钮时,将用户在输入框中填写的手机号发送给API,然后把API的返回结果显示出来就可以了。

调API的流程和调用一个服务的流程是完全一样的,即发起请求 ==》填写接收参数 ==》返回请求结果。
注意:这个返回结果的下拉菜单选项,是由我们的结果格式决定的,比如,省的信息就是在返回结果 result.province中,因此我们可以在公式编辑器中直接选择。这也是为什么我们需要在上一步API调试后,保存结果结构。如果没有了个步骤,只是调试的话,事件面板就无法自动给出这个下拉菜单选项。

2、后台调用API

前台的API和后台API的基本使用方法是一样的,只是后台的API,发起请求的起点是iVX后台服务,可以等API返回后,一起进行数据处理,然后再返回给前端。使用后台调用API的好处主要是安全性,比如,我们有一个付费的API,里面的API key不希望被别人知道,这样他们就可以用这个key来调用我们的付费API了,这个时候我们可以通过后台服务来调用API,这样别人就无法通过浏览器请求看到我们的API请求参数了。

注意:由于后台服务的默认超时时长是10秒,因此,如果我们某个API的等待时长非常长,可能会导致我们的服务超时,此时,只能通过前端调用的方法来调用了。

上一篇: AnLi君的自由之路

下一篇: ivx后台组件:数据库组件

推荐阅读

添加新评论