Einführung

Das Efecte Service Management Tool (ESM) verfügt über eine offene API , die die Verbindung mit jedem externen System ermöglicht. Diese Verbindung wird durch eine REST API ermöglicht, die die moderne Integration mit verschiedenen externen Anwendungen erleichtert. Basierend auf REST -Prinzipien bietet diese API eine vielseitige und effektive Möglichkeit zur Datenverarbeitung innerhalb der Plattform.

Die Efecte REST API verfügt über umfassende Funktionen zur Unterstützung von Entwicklern, zur reibungsloseren Integration und zur Verbesserung der Zusammenarbeit verschiedener Systeme.

Unternehmen, unabhängig von ihrer Größe, arbeiten mit zahlreichen vernetzten Systemen und Prozessen. Diese Systeme können innerhalb einer Abteilung oder über mehrere Abteilungen verteilt sein. Durch die Integration dieser wichtigen Systeme können Unternehmen den manuellen Aufwand deutlich reduzieren. Die Efecte REST API unterstützt dieses Vorhaben, indem sie Entwicklern eine sichere und benutzerfreundliche Schnittstelle bietet.

Um die REST API in einer Efecte-Umgebung zu aktivieren, stellen Sie sicher, dass das Efecte Service Management Tool (ESM) auf Version 2021.4 oder höher aktualisiert ist. Für die Aktivierung benötigen Sie eine REST API Lizenz von Efecte, die das Efecte External API Modul Ihres Systems aktiviert. Darüber hinaus sind die Einrichtung eines technischen (lokalen) Benutzers und die Definition seiner Rolle notwendige Schritte zur Verwaltung des Zugriffs.

Wichtig zu beachten: Die REST API deckt keine Verwaltungsfunktionen oder die Datenmodellverwaltung innerhalb des Efecte-Systems ab. Eine detaillierte Übersicht über die Funktionen der REST API finden Sie in unserer Efecte REST API Dokumentation.

Empfohlene Szenarien

Die REST API ist in vielen Situationen nützlich, in denen Sie Daten an ESM senden oder von ESM empfangen müssen. Sie ist die erste Wahl für Efecte-Kunden und -Partner, wenn es um die Herstellung von Verbindungen mit ESM geht. Häufige Anwendungsgebiete sind die Einbindung von Anlagen- und Konfigurationsdetails aus Inventarisierungstools, die Anbindung an andere ITSM- oder Ticketing-Plattformen, die Verknüpfung mit ERP-Systemen, die Synchronisierung mit HR-Systemen sowie die Anbindung an Reporting- und Analysetools.

Dokumentation

Die REST API Dokumentation finden Sie über die unten stehenden Links.

• REST API Übersicht
• REST API Schnittstellenbeschreibung

Zusätzlich zur Standarddokumentation bietet Efecte auch Online-Dokumentation über Swagger an, ein praktisches Tool für die Interaktion mit der API und die Anzeige detaillierter Dokumentation. Diese Online-Ressource ist in jeder Umgebung mit einer gültigen REST - API Lizenz verfügbar. Sie erreichen die Swagger Benutzeroberfläche, indem Sie zu Ihrer Basis-URL und anschließend zu /rest-api/itsm/v1/docs/swagger/index.html navigieren (z. B. https://efectecloud.com/rest-api/itsm/v1/docs/swagger/index.html ).

Swagger erstellt diese Dokumentation gemäß der Open API 3.0-Spezifikation. Darüber hinaus kann diese Dokumentation über die Benutzeroberfläche unter Ihrer Basis-URL, gefolgt von /rest-api/itsm/v1/docs/openapi.json , heruntergeladen werden. Nach dem Download kann die Dokumentation in verschiedene Integrations- und Testtools wie Postman importiert werden, um eine effizientere API Erkundung und -Tests zu ermöglichen.