GlobalSuite® API

Durch die Nutzung der APIs können Sie GlobalSuite® in andere Anwendungen, Tools oder Systeme Ihrer Unternehmensumgebung integrieren. Zum Beispiel:

• Sie können den Import von Assets aus anderen Tools automatisieren.

• Informationen synchronisieren, um sie in einem anderen Tool für deren Verwaltung zu exportieren.

• Datensätze exportieren, um sie in einem Repository oder Data Lake (EDL) zu speichern.

Sie können die GlobalSuite® API über das Dokumentations-Repository API GlobalSuite® einsehen. Es ist auch möglich, direkt Tests durchzuführen, um die angebotenen Operationen zu überprüfen, sei es Lesen, Schreiben, Ändern oder Löschen von Daten.

HINWEIS: Wenn Sie mit der Nutzung der GlobalSuite® APIs beginnen möchten, wenden Sie sich bitte an Ihren Anbieter.

Es gibt Demo-Umgebungen, die angefordert werden können, um die verfügbaren APIs zu überprüfen und Integrationstests durchzuführen:

Europa:

• URL (API-Dokumentation):

  • https://demo-eu.globalsuitesolutions.com/docs

• URL (API-Integration):

  • https://demo-eu.globalsuitesolutions.com/v1

Latam:

• URL (API-Dokumentation):

  • https://demo-la.globalsuitesolutions.com/docs

• URL (API-Integration):

  • https://demo-la.globalsuitesolutions.com/v1

API-Schlüssel aktivieren

Die GlobalSuite® APIs werden sicher verwendet, um unbefugte Nutzung zu verhindern. Dazu ist es erforderlich, einen API-Schlüssel oder Token zu erstellen, der authentifizierte Anfragen ermöglicht.

Diese API-Schlüssel werden mit einer bestimmten Gültigkeitsdauer (einem Datumsbereich) generiert, der vom Kunden oder Integrator festgelegt wird. Vor oder nach den angegebenen Daten ist der API-Schlüssel ungültig, und Anfragen an die Endpunkte geben die folgende Fehlermeldung 403 zurück:

Untereinheiten

Wenn in GlobalSuite® mehrere Unterentitäten aktiviert sind, muss für jede Entität, die mit einem eigenen oder einem Drittanbieter-Tool oder -Dienst integriert werden soll, ein spezifischer API-Schlüssel generiert werden.

In GlobalSuite® ist die Konfiguration auf Unternehmensebene für alle Entitäten einheitlich, aber die Daten und Datensätze sind spezifisch für jede einzelne. Wenn ein Informations-Repository mit einem Abschnitt des Tools integriert werden soll (z. B. Inventar von Elementen), muss für jede Entität ein API-Schlüssel erstellt werden, da die mit diesem API-Schlüssel erstellten Elemente in der konfigurierten Entität erstellt werden.

HINWEIS: Wenn keine mehreren Entitäten vorhanden sind, ist es nicht erforderlich, mehrere Schlüssel zu definieren.

Best Practices und Tipps

• Stellen Sie sicher, dass Sie für jede Anwendung oder Integration nur einen API-Schlüssel verwenden.

• Ändern Sie den verwendeten API-Schlüssel regelmäßig, um die Sicherheit zu erhöhen.

Verwendung der API-Dokumentation

In der Dokumentation der API GlobalSuite® werden die verschiedenen Elemente oder Modelle angezeigt, die automatisiert konsumiert werden können.

Jede dieser Ressourcen ist eine symbolische Darstellung eines Objekts aus dem Geschäftsdomain von GlobalSuite®. Zum Beispiel ein Service, ein Mitarbeiter usw.

Für jedes der Modelle können die erlaubten Endpunkte oder Operationen GET, PUT, POST und DELETE eingesehen werden:

Diese Endpunkte entsprechen den grundlegenden CRUD-Operationen (Create, Read, Update und Delete):

• GET: Endpunkt, um eines oder mehrere der zu konsultierenden Modelle abzurufen, wobei Filterungen dieser Abfragen möglich sind.

• POST: Endpunkt, um einen neuen Datensatz eines bestimmten Modells zu erstellen.

• PUT: Endpunkt, um einen der Werte oder Felder des Modells zu ändern oder zu aktualisieren.

• DELETE: Endpunkt, um einen bestimmten Datensatz des Modells zu löschen.

Die Dokumentation jedes dieser Endpunkte enthält die Parameter, obligatorisch oder optional, die in jeder Anfrage enthalten sein können:

Auch im eigenen Explorer werden Antwortbeispiele angezeigt, die in jedem Fall bereitgestellt werden, einschließlich korrekter Antworten oder Fehlermeldungen, falls zutreffend.

Verwendung eines REST-Clients

Um Anfragen an die GlobalSuite® API zu stellen, können verschiedene Clients verwendet werden, die HTTP-Anfragen an den GlobalSuite®-Server senden. Es können sowohl einfache Anfragen als auch komplexere Prozesse mit Tools wie cURL oder Postman durchgeführt werden.

Rate Limit

Um Leistungsprobleme oder Brute-Force-Angriffe wie DDoS oder ähnliche zu vermeiden, wurde ein Rate-Limit-Mechanismus implementiert, der die Anzahl der API-Anfragen in einem bestimmten Zeitraum einschränkt.

Dieses Limit ist allgemein, daher wird die Gesamtzahl der mit demselben API-Schlüssel durchgeführten Anfragen berücksichtigt, auch wenn es sich um Anfragen an verschiedene Endpunkte oder Datensätze handelt.

Derzeit liegt dieses Limit bei 180 Anfragen pro Minute.

Wenn dieses Limit überschritten wird, geben die folgenden Anfragen die Fehlermeldung 429 "Too Many Attempts" zurück, um anzuzeigen, dass die Rate-Limit überschritten wurde, und es ist notwendig, zu warten, um sie weiter nutzen zu können.

Hilfe: Referenzdokumentation

• Bevor Sie die GlobalSUITE® APIs verwenden, empfehlen wir, sich mit dem GlobalSuite® Benutzerhandbuch vertraut zu machen, da es eine enge Verbindung zwischen der Geschäftslogik und der API gibt.

• Wenn Sie Fragen oder mögliche Probleme mit einem der in der GlobalSuite® API-Dokumentation verfügbaren Endpunkte haben, können Sie sich an unser Kundensupport-Center wenden.

• Verwenden Sie die GlobalSuite® API-Dokumentation, um Referenzen für die neueste verfügbare Version der REST-API zu finden.

GlobalSUITE® Sicherheitszertifizierung (CSWA)

Im Rahmen des kontinuierlichen Verbesserungszyklus unserer Entwicklungsprozesse, die in GlobalSuite® verwendet werden, haben wir eine externe Validierung durch ein Ethical Hacking Sicherheitsaudit durchgeführt.

Diese Überprüfung wurde gemäß den Standards OWASP Top Ten 2017 und API Security Top 10 2019 durchgeführt, wobei die von beiden Standards vorgeschlagenen Kontrollen in unsere Verifizierungs- und Compliance-Prozesse integriert wurden.

Dieser Auditprozess hat es ermöglicht, die Sicherheit und Resilienz von GlobalSUITE® zu zertifizieren, was zum CSWA-Zertifikat in unseren SaaS- und On-Premise-Umgebungen geführt hat.

API-Versionierung

Im Rahmen der Wartung und des Service der von GlobalSuite® angebotenen APIs ist das Management von Versionen und die Kontrolle von Änderungen enthalten.

Die API wird immer in ihrer aktuellsten Version ( Current) angeboten, die gültig bleibt, bis ein Produktupdate durchgeführt wird, das eine Breaking Change darstellt.

Dieser Breaking Change ist ein Update, das die Struktur von Anfragen und/oder Antworten eines der angebotenen Endpunkte ändert.

Wenn diese Situation eintritt, wird die vorherige Version in den Status Deprecated versetzt, bleibt jedoch zugänglich, bis ein weiterer Breaking Change auftritt, um Anpassungen (falls erforderlich) vorzunehmen, um die durchgeführten Integrationen aufrechtzuerhalten.

Die Updates der GlobalSuite® Versionen werden nach einem Update in der eigenen Anwendung benachrichtigt und können jederzeit im GlobalSuite® Changelog eingesehen werden.

Liste der GlobalSuite® API-Versionen