检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
用。本章节中创建了2个业务脚本,因此需要对应创建2个公共接口,供前端页面调用。 创建公共接口的入口:在APP视图下,单击下方“服务”,即可进入公共接口创建页面。 图1 创建公共接口入口 图2 公共接口基本信息 图3 公共接口URL 父主题: 背景和原理
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
创建公共接口 参考之前创建公共接口的步骤,创建“查询维修人员”脚本对应的公共接口。 操作步骤 在经典版应用开发页面的设计视图下,单击“服务”,进入公共接口创建页面。 图1 服务入口 单击“新建”,如下图所示。 图2 公共接口创建 创建“处理工单”、“判断下一步状态”脚本对应的公共接口,详细接口信息如表1所示。
创建公共接口 参考之前创建公共接口的步骤,创建“查询维修人员”脚本对应的公共接口。 操作步骤 在设计视图下,单击下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 在公共接口页面,单击“新建”。 图2 公共接口创建 创建“查询维修人员”、“派单功能”脚本对应的公共接口,详细接口信息如表1所示。
pments”创建一个关联的公共接口即可,脚本则不需要重复创建。 操作步骤 进入创建“设备维修管理系统”应用中创建的应用。 单击页面下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入公共接口创建页面。 图2 公共接口创建 创建“删除设备”脚本对应的
创建公共接口 在经典版应用开发页面,单击左侧导航栏下方的“服务”,进入公共接口创建页面。 图1 服务入口 在公共接口中,单击“新建”。 图2 公共接口创建 创建“用户登录”、“用户注册”脚本对应的公共接口,详细接口信息如表1所示。 如果在“资源”下拉框中,未找到需要关联的脚本或服
client_secret:鉴权的密钥。 根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token
源。 在接口列表中,单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图5 API接口请求参数信息 图6 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: API接口
在应用中,单击下方“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入新建公共接口页面。 图2 公共接口创建 创建“编辑设备”脚本“HW__editEquipment”的公共接口。 设置接口参数信息,设置标签和操作名称为“editEquipment”,版本为“1.0.0”
如何控制接口访问权限 什么是业务权限凭证 业务权限凭证用于控制接口的访问权限。AstroZero提供了两种方式对API接口访问权限的控制:配置自定义接口前置脚本和配置API接口的业务权限凭证。优先通过自定义接口前置脚本进行权限验证,根据脚本的返回值判断下一步的操作。 对于配置了业
”,可给接口添加业务权限凭证。 预览测试接口。 在自定义接口列表中,单击接口所在行的,预览接口。 若为公共接口,支持查看接口参数并进行在线测试。若为私有接口,只可查看接口的入参和出参。 图2 公共接口 图3 私有接口 单击接口URL后的,可查看接口的参数。 若为公共接口,单击“测
我的应用”中,单击已创建的原生服务。 在原生服务开发页面,单击“公共接口”。 在公共接口页面,单击“新建”。 在“新建自定义接口”页面,设置接口参数。 图2 “新建自定义接口”配置页面 名称:新建公共接口的名称。 版本:公共接口的版本号。 URL:新URL地址。其中,“/native”是固定值,其次是“/Native
js文件中,定义桥接器处理逻辑。 组件中,常用桥接器的相关API,如表1所示。 表1 桥接器API列表 API名称 详细说明 getConnectorInstanceByName('APIConnector') 通过桥接器的变量名称获取桥接器实例,其中“APIConnector”类型为String,表示桥接器的变量名称。
如何对接口鉴权 通过Rest连接器,只需简单配置即可实现方便快捷的调用第三方接口。但是为了保证接口调用安全,调用第三方系统开放的Rest接口,通常需要进行鉴权。当前Rest连接器,集成了如下几种通用的鉴权方式。 OAuth鉴权模式 简单消息头鉴权 JWT鉴权模式 HTTPS双向认证鉴权
导入业务权限凭证 在页面下方,单击“服务”,进入公共接口页面。 图4 创建公共接口入口 为“createWorkOrder”公共接口,添加客服人员业务凭证“cs”。 在接口列表中,单击“createWorkOrder”接口,进入接口详情。 在接口详情页面,单击“业务权限凭证”下的“编辑”。
client_secret:鉴权的密钥。 根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”,获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token
使用SOAP服务调用SOAP协议接口 当系统需要调用第三方提供的SOAP协议接口时,可以通过配置SOAP服务来实现,SOAP服务是第三方系统提供的,是一组模块化的SOAP接口,通过配置第三方提供的SOAP服务的URL进行调用。对接SOAP服务后,可以为服务添加动作,动作用于将第三方接口转换成Astr
个新的资源。 返回“集成”页面,单击已创建接口后的,选择“查看”,进入接口预览页面。 单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图2 API接口请求参数信息 图3 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。
钥生成身份凭证,服务端使用密钥进行解析,信息是经过数字签名的,因此可以被验证和信任。一般用于AstroZero内部服务之前的相互访问。 使用说明 JWT鉴权模式通过客户端和服务端,约定签名密钥。客户端根据密钥生成身份凭证,服务端使用密钥进行解析,信息是经过数字签名的,因此可以被验
测试成功,单击编辑器上方的,启用发布脚本。 创建“查询工单”公共接口 在“我的应用”中,单击“设备维修管理系统”,进入应用。 单击页面下方的“服务”,进入公共接口创建页面。 单击“新建”,创建“查询工单”脚本“HW__queryWorkOrder”的公共接口。 设置接口参数信息:操作名称为“queryWorkOrder”,版本为“1