Skip to main content

Introduction SmartProcess API

Note: To be able to use the SmartProcess API, it is necessary to configure the API profile in the settings.. A REST/OData API is defined for SmartProcess, which can be used to integrate data from thi…

Christoph Lemos
Updated by Christoph Lemos
Note:
To be able to use the SmartProcess API, it is necessary to configure the API profile in the settings.

A REST/OData API is defined for SmartProcess, which can be used to integrate data from third-party systems into SmartProcess. Data from SmartProcess can therefore be used in third-party systems and, conversely, data from third-party systems can be transferred to SmartProcess. Thereby, the REST API supports the OData standard, so that an integration into SAP systems is easily possible.

Example: A new article is added to your ERP system. Through an API call, this article will then also be created in the catalogue of SmartProcess.

There are two ways to connect your enterprise applications to SmartProcess:

  • Direct API connection - Connect your enterprise application to SmartProcess by defining/programming the triggers and the actions to be executed in SmartProcess by yourself.
  • Connection via Zapier - If your enterprise application is registered at Zapier, the connection to SmartProcess can be established conveniently at a user interface without a line of program code. There you can select predefined actions to be executed in SmartProcess.

Currently available data and operations

The following data and actions can currently be triggered in SmartProcess via the interface:

Catalogues

  • Read catalogue entries
  • Create catalogue entries
  • Change catalogue entries
  • Delete catalogue entries

Cases

  • Read cases
  • Create cases
  • Change cases
  • Delete cases

Attachments

  • Read attachments
  • Create attachments
  • Change attachments
  • Delete attachments

Note on using the REST API interface

SmartProcess is used primarily based on user actions. The REST interface provided is solely intended to support the primary workflows of SmartProcess. Any use beyond this purpose, in particular as a general data store, is not permitted.

To ensure the smooth operation of SmartProcess, the use of the REST API is limited. This applies to the number of calls, the volume of data and the time of use. These limitations are designed to ensure that the main use is within the intended workflows.

How did we do?

Direct API connection

Contact