利用 SAP Build Process Automation API

学习目标

  • 利用 SAP Build Process Automation 应用程序编程接口

什么是 REST API?

当然,大多数基于云端构建并在云中运行的应用程序和服务都依赖于 REST API:

REST(= 表述性状态转移)

是一种体系结构样式,用于定义有关如何在 Web 中设计组件的特定准则和约束。它特别强调这些构成部分的互动和沟通。

API(= 应用程序编程接口)

定义其他组件如何联系组件,以触发特定功能或交换数据。

REST API(也称为 RESTful API)是符合 REST 体系结构样式定义的准则和约束的 API。

最终用户通常不直接访问云应用程序和服务的 REST API。他们主要使用提供图形用户界面 (GUI) 的应用程序,并编写来自更多云应用程序和组件的相关信息,从而使用 REST API。因此,REST API 对最终用户隐藏。但是,对于开发人员或管理员来说,这可能有所不同,因为他们可能想要使用或测试不是由具有 GUI 的应用程序提供的功能。

在开发流程中,开发人员可能需要测试或模拟某些组件的各个功能,而与整个系统或体系结构相关的其他组件无关。例如,开发人员正在处理审批缺勤请求的新流程。在生产场景中,该流程应由其他团队开发的应用程序触发。应用程序将调用 SAP Build Process Automation 的 REST API 以触发缺勤审批流程。由于应用程序尚不存在,因此开发人员希望在测试开发流程期间手动触发 REST API。为此,他们可以使用所谓的 REST 客户端。

REST 客户端是一种简化与 REST API 的技术通信的工具。它提供了所需技术通信协议(如 HTTPS)的接口,并促进其使用。

在 SAP Build Process Automation 上下文中,可能对 REST 客户端感兴趣的另一个角色是操作员或管理员。此角色管理、处理,并且可能需要一次性执行一次不规则任务。例如,这些任务可以是清理任务。SAP Build Process Automation 的许多管理和操作功能可通过"监控流程和工作流实例"和"管理流程和工作流"应用使用,但某些功能只能通过其 REST API 使用。

在 SAP Business Accelerator Hub 中发现 SAP Build Process Automation API

输入 SAP API Business Hub(即将替换的链接)并搜索产品 SAP Build Process Automation 时,您将找到相应的 API 包。接下来,您可以找到其包含的不同 API,以及如何利用这些 API 的一个示例。

自动化执行

构建应用程序,允许您通过单击按钮启动特定自动化。

自动化监控

检索过去自动化运行的日志,并在其他工具中对其进行管理。

决策

使用 REST 客户端执行规则服务,以测试其是否产生预期结果。

收件箱

构建一个自定义收件箱应用程序,其外观与 SAP 提供的标准我的收件箱应用程序不同。此用例还需要流程和工作流 API。

工作流

让另一个应用程序触发新的流程或工作流实例。

可见性场景

通过将流程事件推送到 SAP Build Process Automation 服务,了解非 SAP 系统中的流程或工作流。

可见性工作区

获取特定用户可以访问的可见性场景概览。

查找要使用的端点

假设你希望了解如何使用 SAP Build Process Automation API 触发新的流程或工作流实例。

在 SAP Build Process Automation API 包中,选择工作流 REST API。您将获得 REST API 的概览和描述。

选择 API 参考以查看其提供的不同 API 端点的详细信息。

选择工作流实例,然后选择用于启动新实例的 POST 端点。

现在,您可以查看相应端点的详细信息。此视图尤为重要,因为它还提供有关执行 API 所需的角色或范围以及调用 API 时所需的参数的详细信息。在以下练习中,您将了解使用 SAP Build Process Automation API 时所需的确切步骤。