为了账号安全,请及时绑定邮箱和手机立即绑定

API是什么?iVX中的API组件该如何使用?(零代码如何调用API)

2020.09.27 13:18 142浏览

API

API组件图标

简介

API,即应用程序接口(Application Programming Interface,简称:API)。是一些由服务商提供或用户自主开发的预定义函数,它对程序内核进行了封装,仅保留数据的输入接口与用户进行通讯,并通过运算返回一个数据值。API的目的是在无需访问源码,或理解内部工作机制的前提下,赋予应用程序开发人员访问一组例程或进行数据通讯的能力。
iH5的Api系统目前可同时支持ih5内置api、用户自主添加的api。

【使用场景】

随着API服务接口日渐开放,我们可以通过API接入的方式,将一些已经成熟的外部程序或数据接口接入H5中,从而在不进行二次开发的基础上就实现更丰富多样的功能。可通过调用特定API接口,实现人脸识别、语音识别、接入天气预报信息、发送手机验证码、判断手机号码归属地等功能。

【使用方法】

API工作流程示意图
用户可自主在iVX工具栏选用api组件,通过将自身系统的接口或外部系统提供的接口的相关信息加入到api组件中,通过事件进行驱动调用。接口所需信息:

  1. api访问地址(一般带http:// 或 https://)
  2. 请求类型(method):post方法、get方法
  3. 请求头(header),一般根据源接口需求来确定是否需要添加。
  4. 请求内容(body),接口中需要获取的参数数据

返回数据主要以json格式为主(暂时不支持xml),如果源接口返回的数据类型为字符类型时(string)api系统将原样返回,可能影响最终数据的展示。

iVX api组件操作流程(以发送验证码API为例)

a. 在组件栏找到API组件,点击添加API
图片描述

b、添加api所需的信息(访问地址、请求方法、请求头、请求内容参数)
请求url:http://passport.ih5.cn/api/auth/get-code-by-phone
请求方法:post
图片描述

c. 对默认的header或body添加默认请求参数
Header参数:
图片描述
Body参数:
图片描述

d、添加返回json对象,从而解析json的对象树,方便后期调用接口的返回结果

e、调试接口,对必填项参数添加测试数据,查看调用结果。可以检测API是否填写错误
图片描述

f、将api的id加入到事件对象中,获得驱动方法
图片描述

g、获取返回结果,可通过通用变量调用或以代码的方式调用。

点击查看更多内容
0人点赞

若觉得本文不错,就分享一下吧!

评论

相关文章推荐

正在加载中
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消