检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API接口 如何开放API接口 如何进行接口鉴权 如何自定义错误码 如何控制接口访问权限 父主题: 经典版开发指导
源。 在接口列表中,单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图5 API接口请求参数信息 图6 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。 父主题: API接口
client_secret:鉴权的密钥。 根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token
个新的资源。 返回“集成”页面,单击已创建接口后的,选择“查看”,进入接口预览页面。 单击接口后的,可查看定义的API信息。 单击“测试一下”,可模拟API接口调用。 图2 API接口请求参数信息 图3 API接口返回参数信息 API接口的请求参数和返回消息体,为绑定的资源(如脚本,服务编排等)所配置的入参和出参。
API 数据模块 元数据 服务编排 脚本 BPM 导入导出 连接器
如何控制接口访问权限 什么是业务权限凭证 业务权限凭证用于控制接口的访问权限。AstroZero提供了两种方式对API接口访问权限的控制:配置自定义接口前置脚本和配置API接口的业务权限凭证。优先通过自定义接口前置脚本进行权限验证,根据脚本的返回值判断下一步的操作。 对于配置了业
查询应用页签的列表。 服务编排 服务编排接口,包括编排Flow和查看服务编排运行实例两个接口。 表3 服务编排接口 API 说明 编排Flow 编排某个服务编排。 查看服务编排运行实例 查询服务编排信息。 脚本 脚本接口,包括运行、调试和获取脚本签名信息等接口。通过这些接口,您可以运行脚本、对脚本进行调试等。
预置API 脚本中预置的API 标准页面中预置的API 高级页面中预置的API
配置API 使用说明 原生服务旨在帮助您在AstroZero平台上或外部系统,调用已开发好的服务。为了完成调用,需要知道服务开放了哪些接口,以及这些接口的请求参数、返回参数,完成设计API后,可在服务编排中进行调用,也可将API再封装为自定义公共接口,供外部系统调用自定义公共接口。
用。本章节中创建了2个业务脚本,因此需要对应创建2个公共接口,供前端页面调用。 创建公共接口的入口:在APP视图下,单击下方“服务”,即可进入公共接口创建页面。 图1 创建公共接口入口 图2 公共接口基本信息 图3 公共接口URL 父主题: 背景和原理
client_secret:鉴权的密钥。 根据鉴权ID和鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”,获取access_token。 表2 接口基本信息 接口名称 接口路径 接口协议 接口方法 token /baas/auth/v1.0/oauth2/token
如何调用API 构造请求 认证鉴权 返回结果
创建公共接口 参考之前创建公共接口的步骤,创建“查询维修人员”脚本对应的公共接口。 操作步骤 在经典版应用开发页面的设计视图下,单击“服务”,进入公共接口创建页面。 图1 服务入口 单击“新建”,如下图所示。 图2 公共接口创建 创建“处理工单”、“判断下一步状态”脚本对应的公共接口,详细接口信息如表1所示。
创建公共接口 参考之前创建公共接口的步骤,创建“查询维修人员”脚本对应的公共接口。 操作步骤 在设计视图下,单击下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 在公共接口页面,单击“新建”。 图2 公共接口创建 创建“查询维修人员”、“派单功能”脚本对应的公共接口,详细接口信息如表1所示。
pments”创建一个关联的公共接口即可,脚本则不需要重复创建。 操作步骤 进入创建“设备维修管理系统”应用中创建的应用。 单击页面下方的“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入公共接口创建页面。 图2 公共接口创建 创建“删除设备”脚本对应的
创建公共接口 在经典版应用开发页面,单击左侧导航栏下方的“服务”,进入公共接口创建页面。 图1 服务入口 在公共接口中,单击“新建”。 图2 公共接口创建 创建“用户登录”、“用户注册”脚本对应的公共接口,详细接口信息如表1所示。 如果在“资源”下拉框中,未找到需要关联的脚本或服
在应用中,单击下方“服务”,进入公共接口创建页面。 图1 创建公共接口入口 单击“新建”,进入新建公共接口页面。 图2 公共接口创建 创建“编辑设备”脚本“HW__editEquipment”的公共接口。 设置接口参数信息,设置标签和操作名称为“editEquipment”,版本为“1.0.0”
脚本中预置的API AstroZero平台的脚本引擎采用TypeScript语言。脚本执行时,TypeScript语言会被翻译成JavaScript语言,由JavaScript引擎执行。 在JavaScript es5的官方标准库外,AstroZero还扩展了10+预置标准库(即
标准页面中预置的API 在开发标准页面时,可以通过编写JS代码,来实现页面组件与后台接口之间的交互。如图1所示,在编写JS代码时,可直接使用系统预置的API。 系统预置的API代码结构样例如下,提供事件上下文context,用于封装常用的对象及API。 context ├──$app
在连接器详情页面,单击测试中的某个接口,再单击“测试一下”,可模拟API接口调用。 以“自然语言处理基础服务”中的“RunNer”接口为例。 图2 单击“RunNer”接口 图3 API接口请求参数信息 请务必按照“示例模型”中的格式配置接口请求参数,各接口请求参数配置说明请参见各服务的API参考,如《自然语言处理基础服务接口说明》。