Die Uptrends API Version 4 ist ein sich entwickelndes Set von API-Aufrufen, mit dem du Prüfobjekt-Einrichtungen verwalten und modifizieren kannst. Die folgenden Aufgaben können damit ausgeführt werden:

  • einen neuen API-Account registrieren, um auf die anderen Methoden in dieser API zuzugreifen
  • ein bestehendes Transaktionsprüfobjekt ändern
  • ein bestehendes Prüfobjekt für Multi-step API ändern
  • ein bestehendes Prüfobjekt klonen
  • ein bestehendes Prüfobjekt löschen

Für andere Operationen empfehlen wir API Version 3. Erfahre mehr über die Wahl von API v3 und API v4.

Zugriff auf API v4 mit Swagger

Du kannst alle API-Methoden auf unserer OpenAPI (Swagger) Spezifikationsseite: https://api.uptrends.com/v4/swagger sehen. Die Seite beschreibt detailliert alle API-Methoden und Du kannst jede Methode einzeln ausführen.

Darüber hinaus kannst du unsere Swagger-Spezifikation zusammen mit Swagger Codegen nutzen, um Client-Code zu erzeugen, mit dem du wiederum die Uptrends API in Deine eigenen Scripts oder Anwendungen integrieren kannst. Weitere Informationen über Swagger und Swagger-Tools findest Du unter Swagger.io.

Authentifizierung

Jede API-Methode erfordert, dass Du Dich anhand eines API-Accounts authentifizierst. Also musst Du zunächst einen Account erstellen. Dafür nutzen wir die Methode /Register. Bei diesem Beispiel verwenden wir die Swagger-Umgebung, um direkt auf die API zuzugreifen und die Methode Register aufzurufen. Der API-Account, den wir gerade erstellen, wird nicht verfallen. Du musst dies also nur einmal durchführen.

  1. Rufe die Swagger-Seite auf und finde und erweitere die Register POST-Methode.
  2. Klicke auf die Schaltfläche zum Ausprobieren (Try it out), um eine Anfrage zu erstellen.
  3. Gib in das Beschreibungsfeld einen einfachen Namen ein, z. B. „Mein API-Account“. Lasse das Typ-Feld frei.
  4. Klicke auf die Schaltfläche „Execute“.
  5. Dein Browser wird Dich nun auffordern, Deine Uptrends Operator-Anmeldedaten einzugeben, d. h. die E-Mail-Adresse und das Passwort für Deine übliche Anmeldung bei Uptrends.
  6. Nach der Anmeldung siehst Du, dass die Antwort Werte für einen Benutzernamen und Passwort enthält: Dies sind die Anmeldedaten für Deinen neuen API-Account.
  7. Bitte speichere diese Anmeldedaten und verwende sie zur Authentifizierung bei allen anderen API-Aufrufen.
  8. Und zu guter Letzt: Denke daran, dass dieser API-Account mit Deinem Operator verknüpft ist. Er wird also Deine Berechtigungen verwenden.