Skip to main content

Einführung SmartProcess API

Hinweis: Um die SmartProcess API nutzen zu können, ist es erforderlich in den Einstellungen das API-Profil zu konfigurieren.. Für SmartProcess ist eine REST/OData API definiert, mit der Daten von Dri…

Christoph Lemos
geändert von Christoph Lemos
Hinweis:
Um die SmartProcess API nutzen zu können, ist es erforderlich in den Einstellungen das
API-Profil zu konfigurieren.

Für SmartProcess ist eine REST/OData API definiert, mit der Daten von Drittsystemen in SmartProcess integriert werden können. Daten aus SmartProcess können also in Drittsystemen verwendet werden und umgekehrt können Daten von Drittsystemen in SmartProcess übernommen werden. Dabei unterstützt die REST API den OData Standard, so dass auch eine Integration in SAP-Systeme einfach möglich ist.

Beispiel: In Ihrem ERP-System wird ein neuer Artikel hinzugefügt. Durch einen API-Aufruf wird dieser Artikel dann auch analog im Katalog von SmartProcess neu erstellt.

Es gibt 2 Arten, Ihre Unternehmensanwendungen mit SmartProcess zu verbinden:

  • Direkte API-Anbindung - Verbinden Sie Ihre Unternehmensanwendung mit SmartProcess, indem Sie die Auslöser und die Aktionen, die folglich in SmartProcess ausgeführt werden sollen, selbst definieren/programmieren.
  • Anbindung über Zapier - Wenn Ihre Unternehmensanwendung bei Zapier registriert ist, kann die Verbindung zu SmartProcess ohne eine Zeile Programmcode bequem an einer Benutzeroberfläche hergestellt werden. Dort können vordefinierte Aktionen ausgewählt werden, die in SmartProcess ausgeführt werden sollen.

Aktuell verfügbare Daten und Aktionen

Folgende Daten und Aktionen können über die Schnittstelle aktuell in SmartProcess verwendet bzw. ausgelöst werden:

Kataloge

  • Katalogeinträge lesen
  • Katalogeinträge erstellen
  • Katalogeinträge ändern
  • Katalogeinträge löschen

Vorgänge

  • Vorgangsdetails lesen
  • Vorgangsdetails erstellen
  • Vorgangsdetails ändern
  • Vorgangsdetails löschen

Anhänge

  • Anhänge lesen
  • Anhänge erstellen
  • Anhänge ändern
  • Anhänge löschen

Hinweis für die Nutzung der Rest API - Schnittstelle

Die Nutzung von SmartProcess basiert im wesentlichen auf Benutzeraktionen. Die Nutzung der bereitgestellten REST-Schnittstelle ist ausschließlich zur Unterstützung der primären Arbeitsabläufe von SmartProcess vorgesehen. Ein Einsatz, der über diesen Zweck hinausgeht, insbesondere als allgemeiner Datenspeicher, ist unzulässig. 

Um den reibungslosen Betrieb von SmartProcess zu gewährleisten wird die Nutzung der REST-API begrenzt. Dies betrifft die Anzahl der Calls, das Volumen der Daten und die Nutzungszeit. Diese Begrenzungen sind darauf ausgelegt, die Hauptnutzung im Rahmen der vorgesehenen Arbeitsabläufe sicherzustellen.

War der Artikel hilfreich?

Direkte API-Anbindung

Kontakt