API Changelog

Die Funktionen von Uptrends‘ API werden mit der Zeit verbessert und erweitert. Dementsprechend werden wir neue Endpunkte und Methoden hinzufügen.

Bei der Einrichtung neuer Funktionen achten wir darauf, rückwärtskompatibel zu bleiben. Änderungen sind jedoch nicht immer vermeidbar und eine neue Version der API wird eventuell nicht mit dem Code kompatibel sein, den du bisher geschrieben und genutzt hast. Schaue regelmäßig im API Changelog nach, um über alle Änderungen auf dem Laufenden zu sein und diese, falls notwendig, zu berücksichtigen.

Zur Dokumentation der API lies unsere Artikel in der Kategorie Uptrends‘ API.

Sollten dich die Änderungen an der Uptrends Anwendung interessieren, schau in unserem allgemeinen Changelog nach.

August 2021

Ankündigung: Auslaufen von Version 3 der unserer API

Die Uptrends API unterstützt derzeit zwei Versionen. Version 3 ist eine ältere Vorgängerversion unserer API und wir empfehlen derzeit, Version 4 zu verwenden. Version 4 verfügt über einen sehr viel vollständigeren Funktionsumfang und ist seit Längerem Entwicklungsschwerpunkt. Wir haben daher entschieden, Version 3 unserer API auslaufen zu lassen. Sie wird ab Dezember 2022 nicht länger verfügbar sein.

Für Kunden, die derzeit noch Version 3 unserer API verwenden, weisen wir darauf hin, dass diese Version noch bis zum genannten Zeitpunkt unterstützt wird. Wir empfehlen jedoch, so bald wie möglich das Upgrade zu Version 4 durchzuführen. Um dir dabei zu helfen, haben wir einen Upgrade-Leitfaden für den Wechsel von API v3 nach v4 verfasst, der die Hauptunterschiede zwischen den zwei API-Versionen und wie du sie in deinen Skripten und deiner Software überbrückst behandelt.

Juli 2021

Code-relevante Änderung: Änderung an der Antwort der OperatorGroup Autorisierung

Mit der Uptrends API kannst du Berechtigungen für Operatoren und Operator-Gruppen verwalten und Rollen wie Administrator und Ansprechpartner Finanzen zuweisen sowie Zugriff auf Infra gewähren. Die OperatorGroup API enthält mehrere Optionen, um Berechtigungen abzurufen, hinzuzufügen oder zu löschen.

Wir haben die Art und Weise geändert, wie Berechtigungen für Operator-Gruppen in der API angegeben werden. Dies kann sich auf eine von dir eingerichtete automatisierte Erstellung, Entfernung oder den Abruf von Informationen über Berechtigungen von Operator-Gruppen auswirken. Derzeit erfolgt der Abruf von Informationen zu Berechtigungen durch:

GET /OperatorGroup/{operatorGroupGuid}/Authorization

was eine Antwort wie unten dargestellt zurückgibt (abhängig von den für die jeweilige Operator-Gruppe eingerichteten Berechtigungen):

[
      {
        "AuthorizationId": "{authIdGuid1}",
        "AuthorizationType": "FinancialOperator",
        "OperatorGroupGuid": "{operatorGroupGuid}"
    },
    {
        "AuthorizationId": "{authIdGuid2}",
        "AuthorizationType": "AllowInfra",
        "OperatorGroupGuid": "{operatorGroupGuid}"
    },
    ...
]

In Zukunft wird diese Abfrage eine vereinfachte Antwort zurückgeben, bei der die Berechtigungen, aber keine weiteren Informationen gelistet werden. In der Antwort werden weder operatorGroupGuid noch AuthorizationId (Letzteres wird komplett entfernt, Berechtigungen werden nicht länger über eine eigene GUID verfügen) enthalten sein. Die Antwort wird folgendermaßen aussehen:

{
    "FinancialOperator",
    "AllowInfra",
    ...
}

Eine neue Berechtigung für eine Operator-Gruppe wird derzeit hinzugefügt durch Senden einer POST-Anfrage an:

/OperatorGroup/{operatorGroupGuid}/Authorization mit einem Request Body, der einen “AuthorizationType” angibt. Die derzeit verfügbaren Werte für AuthorizationType für Operator-Gruppen findest du in der Uptrends API Swagger UI, unter Models (unten) und dann OperatorGroupAuthorizationType.

Zukünftig kann eine neue Berechtigung für eine Operator-Gruppe hinzugefügt werden durch Senden einer POST-Anfrage an:

/OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType} ohne einen Request Body einzufügen.

Das Löschen einer Berechtigung aus einer Operator-Gruppe wird derzeit durch Senden einer DELETE-Anfragen an /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationGuid} durchgeführt, aber wie oben erwähnt wird “authorizationGuid” als Einheit nicht länger unterstützt und kann nicht mehr genutzt werden. Stattdessen kannst du Berechtigungen löschen, indem du dich direkt mit ihrem Namen in der Anfrage-URL auf sie beziehst: /OperatorGroup/{operatorGroupGuid}/Authorization/{authorizationType}

Februar 2021

Code-relevante Änderung: sensible Werte bei Multi-step API-Prüfobjekten

Unser Prüfobjekttyp Multi-step API ermöglicht dir, mehrere aufeinanderfolgende HTTP-Anfragen auszuführen, bei denen jede neue Anfrage ein oder mehrere abgerufene Datenteile aus vorherigen Anfragen nutzt, um seine Aufgabe auszuführen. Häufig gehört zu einem der Schritte das Senden von Anmeldedaten, um Zugriff auf eine bestimmte Ressource zu erhalten. Früher wurden diese Anmeldedaten als vordefinierte Variablen zur Prüfobjektdefinition hinzugefügt und als sensibel gekennzeichnet.

Um die Sicherheit der Handhabung solcher Anmeldedaten zu steigern, geben wir diese Vorgehensweise auf. Stattdessen werden diese Anmeldedaten in der Vault abgelegt. Mit dieser Änderung wird bei Multi-step API-Prüfobjekten die Kennzeichnung vordefinierter Variablen als sensibel überflüssig und wir werden diese Funktion entfernen.

Dies wird sich darauf auswirken, wie du über unsere API Multi-step API-Prüfobjekte erstellen und mit ihnen interagieren kannst. Derzeit enthält die Prüfobjektdefinition für diesen Prüfobjekttyp ein Array „PredefinedVariables“, bei dem jede einzelne Variable über einen booleschen Wahr-Falsch-„Sensibel“-Ausdruck verfügt. In nächster Zukunft wird dieser boolesche Ausdruck aus der Definition entfernt. Wenn du ein Multi-step API-Prüfobjekt in deinem Account mithilfe der Uptrends API erstellen oder aktualisieren möchtest, wird dieses Feld nicht mehr verfügbar sein.

Änderung: umbenanntes Routing

Bei Uptrends APIv4 ist die Vorgehensweise, Routes zu benennen, nicht einheitlich. In den meisten Fällen werden Singular-Begriffe genutzt, aber in einigen Fällen waren diese auch in der Plural-Form. Die Route enthält nun nur Singular-Elemente, zum Beispiel /MonitorGroup/{monitorGroupGuid}/Member statt /MonitorGroup/{monitorGroupGuid}/Members.

Aus Gründen der Rückwärtskompatibilität unterstützen wir weiterhin die alten Routes.

Durch die Nutzung dieser Website stimmen Sie der Verwendung von Cookies gemäß unserer Cookie-Richtlinien zu.