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

ApiUser API

Overzicht

Een API-gebruiker is een set inloggegevens die een operator gebruikt om zich te authenticeren bij de Uptrends API. API-gebruikers staan los van de Uptrends-inloggegevens van een operator, zodat u ze kunt gebruiken in scripts, integraties en automatisering zonder accountwachtwoorden bloot te stellen.

Elke operator kan meerdere API-gebruikers hebben, elk met een eigen gebruikersnaam, wachtwoord en toegangstype. Het toegangstype identificeert de client of applicatie die de inloggegevens gebruikt. Bijvoorbeeld Generic voor scripts en automatisering, MobileApp voor de mobiele app van Uptrends of TransactionRecorder voor Uptrends Transaction Recorder.

Gebruikssituaties

  • API-inloggegevens van een operator beheren — API-gebruikers programmatisch creëren, bijwerken en verwijderen, inclusief gebruikersnaam, wachtwoord en API-toegangstype.
  • API-gebruikersdetails ophalen om API-activiteit bij te houden en toegang te beheren — gebruiksdetails beheren, zoals wanneer inloggegevens voor het laatst zijn gebruikt of hoeveel verzoeken er in de afgelopen 30 dagen zijn gedaan.

Vereisten

Voordat u de ApiUser API gebruikt, moet u ervoor zorgen dat u beschikt over:

ApiUser API-eindpunten

De ApiUser API biedt de volgende eindpunten voor het beheren van API-informatie:

Methode Eindpunt Beschrijving
GET /ApiUser Retourneert een lijst met alle API-gebruikers in het account.
POST /ApiUser Creëert een nieuwe API-gebruiker voor een operator. Geef in de request body alleen OperatorGuid en Description op. Alle andere velden zijn alleen-lezen of worden toegewezen door de API.
GET /ApiUser/Operator/{operatorGuid} Retourneert een lijst met API-gebruikers van de opgegeven operator.
GET /ApiUser/{apiUserGuid} Retourneert details voor de opgegeven API-gebruiker, inclusief de operator-GUID, gebruikersnaam, toegangstype en laatst-gebruikt-datum.
PUT /ApiUser/{apiUserGuid} Werkt de opgegeven API-gebruiker bij. Geef in de request body alleen OperatorGuid en Description op. Alleen Description kan worden bijgewerkt. De OperatorGuid die aan de API-gebruiker is gekoppeld moet ongewijzigd blijven.
DELETE /ApiUser/{apiUserGuid} Verwijdert de opgegeven API-gebruiker.

Raadpleeg de Uptrends ApiUser API-documentatie voor gedetailleerde request- en responsindelingen en interactieve API-tests.

ApiUser API-voorbeelden

GET-respons

Voorbeeldrespons voor 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} retourneert één object met dezelfde velden, geen array.

POST request body

Voorbeeld request body voor POST /ApiUser:

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

De OperatorGuid moet overeenkomen met de bestaande API-gebruiker. Een geslaagde update retourneert 204 No content.

PUT request body

Voorbeeld request body voor PUT /ApiUser/{apiUserGuid}:

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

Een geslaagde update retourneert 204 No Content.

ApiUser API-parameters

Veldnaam Beschrijving
OperatorGuid Padparameter. De GUID van de operator waarvan u de API-gebruikers wilt ophalen.
ApiUserGuid Padparameter. De GUID van de API-gebruiker die u wilt ophalen, bijwerken of verwijderen.

ApiUser API-velden

Opmerking

Sommige ApiUser-velden zijn alleen-lezen of worden automatisch toegewezen door de API.

ApiUser resources gebruiken de volgende eigenschappen in request en response bodies:

Veldnaam Beschrijving
ApiUserGuid De unieke identifier van de API-gebruiker. Wordt automatisch toegewezen wanneer een API-gebruiker wordt gecreëerd.
OperatorGuid De unieke identifier van de operator die aan deze API-gebruiker is gekoppeld. Vereist in POST en PUT request bodies. U kunt de OperatorGuid van een bestaande API-gebruiker niet wijzigen in een PUT-verzoek.
UserName De gebruikersnaam die samen met het wachtwoord wordt gebruikt om API-verzoeken te authenticeren. Wordt automatisch toegewezen wanneer een API-gebruiker wordt gecreëerd. Alleen-lezen.
Password Het wachtwoord dat samen met de gebruikersnaam wordt gebruikt om API-verzoeken te authenticeren. Wordt automatisch toegewezen wanneer een API-gebruiker wordt gecreëerd. Weggelaten uit GET-responsen. Niet opgenomen in POST of PUT request bodies.
Type

Identificeert de client of applicatie die de API-inloggegevens gebruikt. Wordt automatisch toegewezen door de API. Alleen-lezen.

  • Generic — standaard en meest voorkomende toegangstype. Wordt gebruikt voor scripts, automatisering of directe toegang tot de Uptrends API.
  • MobileApp — wordt gebruikt voor API-verzoeken vanuit de mobiele applicatie van Uptrends.
  • TransactionRecorder — wordt gebruikt door Uptrends Transaction Recorder bij het creëren of bijwerken van transactiecontroleregels.
Description Details van de API-gebruiker. Bijvoorbeeld Transaction Recorder of Private Location healthchecks.
CreatedDate De datum en tijd waarop de API-gebruiker is gecreëerd. Alleen-lezen.
LastUsed De datum en tijd van het laatste API-verzoek. Alleen-lezen.
UsageLast30Days Aantal verzoeken dat in de afgelopen 30 dagen is gedaan. Alleen-lezen.

Probleemoplossing

Dit gedeelte behandelt veelvoorkomende HTTP-fouten en stappen voor probleemoplossing voor de ApiUser API.

Veelvoorkomende fouten

Veelvoorkomende HTTP-statuscodes en hun beschrijvingen:

Statuscode Beschrijving
200 OK — verzoek geslaagd.
201 Created — de API-gebruiker is succesvol gecreëerd. De response body bevat de nieuwe API-gebruiker, inclusief de toegewezen ApiUserGuid.
204 No content — het verzoek is succesvol voltooid en er is geen response body geretourneerd. Dit geldt voor geslaagde PUT- en DELETE-verzoeken.
400

Bad request — ongeldige verzoekparameters of ontbrekende vereiste velden.

  • Voor DELETE-verzoeken gebeurt dit ook wanneer u probeert de API-gebruiker te verwijderen die is gekoppeld aan de inloggegevens die u gebruikt om het verzoek te authenticeren.
  • Voor PUT-verzoeken gebeurt dit ook wanneer de OperatorGuid die aan een bestaande API-gebruiker is toegewezen wordt gewijzigd.
401 Unauthorized — ongeldige of ontbrekende authenticatiegegevens.
403 Forbidden — er zijn een of meer validatiefouten opgetreden. Dit kan verband houden met accountmachtigingen.
404 Not Found — de opgegeven operatorGuid of apiUserGuid is niet gevonden.
500 Internal Server Error — er is een serverfout opgetreden.

Algemene gids voor probleemoplossing

Zorg ervoor dat u:

  • Uw verzoekgegevens altijd valideert voordat u API calls verzendt.
  • Geschikte HTTP-methoden gebruikt voor elke bewerking.

Neem voor verdere hulp contact op met ons Support-team.

Gerelateerde artikelen

Raadpleeg de volgende artikelen voor meer details:

Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.