1. Support
  2. Knowledge Base
  3. Uptrends' API
  4. ApiUser API

ApiUser API

Überblick

Ein API-Nutzer ist ein Satz von Anmeldedaten, den ein Operator zur Authentifizierung bei der Uptrends API verwendet. API-Nutzer sind von den Uptrends Anmeldedaten eines Operators getrennt, sodass du sie in Skripten, Integrationen und Automatisierungen verwenden kannst, ohne Account-Passwörter offenzulegen.

Jeder Operator kann mehrere API-Nutzer haben, jeweils mit eigenem Benutzernamen, Passwort und Zugriffstyp. Der Zugriffstyp gibt den Client oder die Anwendung an, die die Anmeldedaten verwendet. Zum Beispiel Generic für Skripte und Automatisierung, MobileApp für die mobile Uptrends App oder TransactionRecorder für den Uptrends Transaction Recorder.

Anwendungsfälle

  • API-Anmeldedaten eines Operators verwalten — API-Nutzer einschließlich Benutzername, Passwort und API-Zugriffstyp programmgesteuert erstellen, aktualisieren und löschen.
  • API-Nutzerdetails abrufen, um API-Aktivität nachzuverfolgen und den Zugriff zu steuern — Nutzungsdetails verwalten, etwa wann Anmeldedaten zuletzt verwendet wurden oder wie viele Anfragen in den letzten 30 Tagen gestellt wurden.

Voraussetzungen

Bevor du die ApiUser API verwendest, stelle sicher, dass du Folgendes hast:

ApiUser API-Endpunkte

Die ApiUser API stellt die folgenden Endpunkte zur Verwaltung von API-Informationen bereit:

Methode Endpunkt Beschreibung
GET /ApiUser Gibt eine Liste aller API-Nutzer im Account zurück.
POST /ApiUser Erstellt einen neuen API-Nutzer für einen Operator. Gib im Request Body nur OperatorGuid und Description an. Alle anderen Felder sind schreibgeschützt oder werden von der API zugewiesen.
GET /ApiUser/Operator/{operatorGuid} Gibt eine Liste der API-Nutzer des angegebenen Operators zurück.
GET /ApiUser/{apiUserGuid} Gibt Details zum angegebenen API-Nutzer zurück, einschließlich Operator-GUID, Benutzername, Zugriffstyp und Datum der letzten Verwendung.
PUT /ApiUser/{apiUserGuid} Aktualisiert den angegebenen API-Nutzer. Gib im Request Body nur OperatorGuid und Description an. Nur Description kann aktualisiert werden. Die mit dem API-Nutzer verknüpfte OperatorGuid muss unverändert bleiben.
DELETE /ApiUser/{apiUserGuid} Löscht den angegebenen API-Nutzer.

Ausführliche Anfrage- und Antwortformate sowie interaktive API-Tests findest du in der Uptrends ApiUser API-Dokumentation.

ApiUser API-Beispiele

GET-Antwort

Beispielantwort für GET /ApiUser:

[
  {
    "ApiUserGuid": "c1534087-590e-497e-b58e-00bc4dbfa1d3",
    "OperatorGuid": "ab12345c-0d8e-46a2-acef-dd1e15571097",
    "UserName": "c1534087590e497eb58e00bc4dbfa1d3",
    "Type": "Generic",
    "Description": "Transaction Recorder",
    "CreatedDate": "2025-11-11T21:18:01",
    "LastUsed": "25/06/2026 19:37:59",
    "UsageLast30Days": 17706
  }
]

GET /ApiUser/{apiUserGuid} gibt ein einzelnes Objekt mit denselben Feldern zurück, kein Array.

POST Request Body

Beispiel-Request Body für POST /ApiUser:

{
  "OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
  "Description": "API description"
}

Die OperatorGuid muss dem vorhandenen API-Nutzer entsprechen. Eine erfolgreiche Aktualisierung gibt 204 No content zurück.

PUT Request Body

Beispiel-Request Body für PUT /ApiUser/{apiUserGuid}:

{
  "OperatorGuid": "ef45547g-0f8h-46a2-acef-dd1e15571390",
  "Description": "Updated API description"
}

Eine erfolgreiche Aktualisierung gibt 204 No Content zurück.

ApiUser API-Parameter

Feldname Beschreibung
OperatorGuid Pfadparameter. Die GUID des Operators, dessen API-Nutzer du abrufen möchtest.
ApiUserGuid Pfadparameter. Die GUID des API-Nutzers, der abgerufen, aktualisiert oder gelöscht werden soll.

ApiUser API-Felder

Hinweis

Einige ApiUser-Felder sind schreibgeschützt oder werden automatisch von der API zugewiesen.

ApiUser-Ressourcen verwenden die folgenden Eigenschaften in Request und Response Bodies:

Feldname Beschreibung
ApiUserGuid Die eindeutige Kennung des API-Nutzers. Wird automatisch zugewiesen, wenn ein API-Nutzer erstellt wird.
OperatorGuid Die eindeutige Kennung des Operators, der mit diesem API-Nutzer verknüpft ist. Erforderlich in POST und PUT Request Bodies. Du kannst die OperatorGuid eines vorhandenen API-Nutzers in einer PUT-Anfrage nicht ändern.
UserName Der Benutzername, der zusammen mit dem Passwort zur Authentifizierung von API-Anfragen verwendet wird. Wird automatisch zugewiesen, wenn ein API-Nutzer erstellt wird. Schreibgeschützt.
Password Das Passwort, das zusammen mit dem Benutzernamen zur Authentifizierung von API-Anfragen verwendet wird. Wird automatisch zugewiesen, wenn ein API-Nutzer erstellt wird. Wird in GET-Antworten ausgelassen. Nicht in POST oder PUT Request Bodies enthalten.
Type

Gibt den Client oder die Anwendung an, die die API-Anmeldedaten verwendet. Wird automatisch von der API zugewiesen. Schreibgeschützt.

  • Generic — Standardzugriffstyp und häufigster Zugriffstyp. Wird für Skripte, Automatisierung oder direkten Zugriff auf die Uptrends API verwendet.
  • MobileApp — wird für API-Anfragen aus der mobilen Uptrends Anwendung verwendet.
  • TransactionRecorder — wird vom Uptrends Transaction Recorder beim Erstellen oder Aktualisieren von Transaktionsprüfobjekten verwendet.
Description Details des API-Nutzers. Zum Beispiel Transaction Recorder oder Private Location Healthchecks.
CreatedDate Datum und Uhrzeit, zu der der API-Nutzer erstellt wurde. Schreibgeschützt.
LastUsed Datum und Uhrzeit der letzten API-Anfrage. Schreibgeschützt.
UsageLast30Days Anzahl der in den letzten 30 Tagen gestellten Anfragen. Schreibgeschützt.

Fehlerbehebung

Dieser Abschnitt behandelt häufige HTTP-Fehler und Schritte zur Fehlerbehebung für die ApiUser API.

Häufige Fehler

Häufige HTTP-Statuscodes und ihre Beschreibungen:

Statuscode Beschreibung
200 OK — Anfrage erfolgreich.
201 Created — der API-Nutzer wurde erfolgreich erstellt. Der Response Body enthält den neuen API-Nutzer einschließlich der zugewiesenen ApiUserGuid.
204 No content — die Anfrage wurde erfolgreich abgeschlossen und es wurde kein Response Body zurückgegeben. Dies gilt für erfolgreiche PUT und DELETE-Anfragen.
400

Bad request — ungültige Anfrageparameter oder fehlende erforderliche Felder.

  • Bei DELETE-Anfragen tritt dies auch auf, wenn du versuchst, den API-Nutzer zu löschen, der mit den Anmeldedaten verknüpft ist, die du zur Authentifizierung der Anfrage verwendest.
  • Bei PUT-Anfragen tritt dies auch auf, wenn die einem vorhandenen API-Nutzer zugewiesene OperatorGuid geändert wird.
401 Unauthorized — ungültige oder fehlende Authentifizierungsdaten.
403 Forbidden — ein oder mehrere Validierungsfehler sind aufgetreten. Dies kann mit Account-Berechtigungen zusammenhängen.
404 Not Found — die angegebene operatorGuid oder apiUserGuid wurde nicht gefunden.
500 Internal Server Error — ein serverseitiger Fehler ist aufgetreten.

Allgemeiner Leitfaden zur Fehlerbehebung

Stelle sicher, dass du:

  • deine Anfragedaten immer validierst, bevor du API-Aufrufe sendest.
  • geeignete HTTP-Methoden für jede Operation verwendest.

Für weitere Unterstützung wende dich bitte an unser Support-Team.

Verwandte Artikel

Weitere Details findest du in den folgenden Artikeln:

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