检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
图1 创建公共接口入口 图2 公共接口基本信息 图3 公共接口URL 父主题: 背景和原理
电话 电话组件用于录入11位数的手机号码。系统已预置校验格式,当用户输入手机号不正确时,会报错。 在表单开发页面,从“数据组件”中,拖拽“电话”组件至表单设计区域,如图1。 图1 电话 显示名称:该字段在页面呈现给用户的名称,可以设置为中文,也可以设置为英文。
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
图2 公共接口创建 创建“处理工单”、“判断下一步状态”脚本对应的公共接口,详细接口信息如表1所示。
创建公共接口 参考之前创建公共接口的步骤,创建“查询维修人员”脚本对应的公共接口。 操作步骤 在设计视图下,单击下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 在公共接口页面,单击“新建”。
单击页面下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入公共接口创建页面。 图2 公共接口创建 创建“删除设备”脚本对应的“HW__deleteEquipment”的公共接口。
创建公共接口 在经典版应用开发页面,单击左侧导航栏下方的“服务”,进入公共接口创建页面。 图1 服务入口 在公共接口中,单击“新建”。 图2 公共接口创建 创建“用户登录”、“用户注册”脚本对应的公共接口,详细接口信息如表1所示。
在接口列表中,单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图5 API接口请求参数信息 图6 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: API接口
对AstroZero API接口进行接口鉴权 操作场景 在AstroZero中,可通过配置OAuth管理第三方接入鉴权。AstroZero采用OAuth 2.0协议,进行接入认证。
操作步骤 在应用中,单击下方“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入新建公共接口页面。 图2 公共接口创建 创建“编辑设备”脚本“HW__editEquipment”的公共接口。
如何控制接口访问权限 什么是业务权限凭证 业务权限凭证用于控制接口的访问权限。AstroZero提供了两种方式对API接口访问权限的控制:配置自定义接口前置脚本和配置API接口的业务权限凭证。优先通过自定义接口前置脚本进行权限验证,根据脚本的返回值判断下一步的操作。
是否已废弃 该接口是否已废弃。 描述 该接口的描述信息。 创建时间 自定义接口的创建时间。 最后修改人 自定义接口的最后修改人。 最近修改时间 最近修改自定义接口的时间。 API类型 接口API类型。
自定义公共接口 使用说明 使用公共接口,可以将原生服务API发布到外部网关,第三方系统可以通过OAuth2.0调用AstroZero上的原生服务。 前提条件 已接入服务实例,具体操作请参考注册Native Service。 已在需要调用原生服务的应用中,添加待调用的原生服务。
如何调用后台接口 在应用开发过程中,经常需要在高级页面组件中调用后台接口来完成整个业务场景(例如获取购物车中用户的ID,订单编号,商品信息等)。为方便用户调用可配置的API,平台提供了桥接器功能。
如何对接口鉴权 通过Rest连接器,只需简单配置即可实现方便快捷的调用第三方接口。但是为了保证接口调用安全,调用第三方系统开放的Rest接口,通常需要进行鉴权。当前Rest连接器,集成了如下几种通用的鉴权方式。
图3 导入业务权限凭证 在页面下方,单击“服务”,进入公共接口页面。 图4 创建公共接口入口 为“createWorkOrder”公共接口,添加客服人员业务凭证“cs”。 在接口列表中,单击“createWorkOrder”接口,进入接口详情。
如何进行接口鉴权 使用说明 AstroZero提供了“客户端模式”和“授权码模式”两种授权模式,进行OAuth鉴权。 客户端模式 通过该模式获取的access-token,用于在调用API接口时进行鉴权,使用时需在请求消息头上设置“access-token”。
图2 API接口请求参数信息 图3 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: 开放接口供第三方系统调用
使用SOAP服务调用SOAP协议接口 当系统需要调用第三方提供的SOAP协议接口时,可以通过配置SOAP服务来实现,SOAP服务是第三方系统提供的,是一组模块化的SOAP接口,通过配置第三方提供的SOAP服务的URL进行调用。
创建“查询工单”脚本及公共接口 本节中的后台逻辑主要是通过脚本的形式,实现对工单记录的查询,然后将查询脚本封装成一个公共接口,供页面调用。 工单列表(客服人员)页面中,为了实现查询并显示已有工单信息功能,需要开发“查询工单”脚本和对应公共接口。