GlobalSuite® API

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

• Sie können die Automatisierung des Imports von Assets aus anderen Tools durchführen.

• Synchronisieren Sie Informationen, um sie in ein anderes Tool zur Verwaltung zu exportieren.

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

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

HINWEIS: Wenn Sie beginnen möchten, die GlobalSuite® APIs zu nutzen, wenden Sie sich bitte an Ihren Anbieter.

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

Europa:

• URL (API-Dokumentation):

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

• URL (API-Integration):

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

Latam:

• URL (API-Dokumentation):

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

• URL (API-Integration):

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

API-Schlüssel aktivieren

Die GlobalSuite® APIs werden sicher verwendet, um unbefugte Nutzung zu verhindern. Dazu muss ein API-Schlüssel oder Token erstellt werden, der authentifizierte Anrufe ermöglicht.

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

Unterentitäten

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

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 Sie ein Informations-Repository mit einem Abschnitt des Tools integrieren möchten (z. B. Inventar von Elementen), muss ein API-Schlüssel für jede Entität 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 einen einzigen API-Schlüssel verwenden.

• Ändern Sie den verwendeten API-Schlüssel regelmäßig für mehr Sicherheit.

Verwendung der API-Dokumentation

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

Jede dieser Ressourcen ist eine symbolische Darstellung eines Geschäftsdomänenobjekts von GlobalSuite®. Zum Beispiel ein Service, ein Mitarbeiter usw.

Für jedes Modell können die Endpunkte oder Operationen GET, PUT, POST und DELETE eingesehen werden, die erlaubt sind:

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

• GET: Endpunkt zum Abrufen eines oder mehrerer Modelle, wobei Filter für diese Abfragen angewendet werden können.

• POST: Endpunkt zum Erstellen eines neuen Datensatzes eines bestimmten Modells.

• PUT: Endpunkt zum Ändern oder Aktualisieren eines der Werte oder Felder des Modells.

• DELETE: Endpunkt zum Löschen eines bestimmten Datensatzes des Modells.

Die Dokumentation jedes dieser Endpunkte enthält die obligatorischen oder optionalen Parameter, die in jedem Anruf enthalten sein können:

Außerdem werden im Explorer selbst Antwortbeispiele angezeigt, die in jedem Fall bereitgestellt werden, einschließlich korrekter Antworten oder Fehlermeldungen, falls vorhanden.

Verwendung eines REST-Clients

Um Anrufe an die GlobalSuite® API zu tätigen, können verschiedene Clients verwendet werden, die HTTP-Anrufe an den GlobalSuite®-Server durchführen. Es können sowohl einfache Anrufe 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-Anrufe in einem bestimmten Zeitraum einschränkt.

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

Derzeit liegt dieses Limit bei 180 Anrufen pro Minute.

Wenn dieses Limit überschritten wird, geben die folgenden Anrufe die Fehlermeldung 429 "Too Many Attempts" zurück, um anzuzeigen, dass die Rate-Limit überschritten wurde, und es ist erforderlich, zu warten, um sie weiterhin 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 Beziehung 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 die Sicherheit und Widerstandsfähigkeit von GlobalSUITE® zertifiziert und das CSWA-Zertifikat in unseren SaaS- und On-Premise-Umgebungen mit sich gebracht.

API-Versionierung

Im Rahmen der Wartung und des Service der von GlobalSuite® angebotenen APIs ist die Versionsverwaltung 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 einen Breaking Change darstellt.

Dieser Breaking Change ist ein Update, das die Struktur von Anrufen 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 erfolgt, um Anpassungen (falls erforderlich) vorzunehmen, um die durchgeführten Integrationen aufrechtzuerhalten.

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

Liste der GlobalSuite® API-Versionen