Server- und API-Endpunkte

Alle Endpunkte sind JSON-basiert (Content-Type meist application/json) und relativ zum Host https://<agent-host>. Antworten folgen dem Muster { success, message, data, total, ... }. Zugriff erfordert ein gültiges AGENTSESSIONID Cookie (siehe „Authentifizierung“). Unbekannte Pfade liefert Jetty mit HTTP 404 zurück.

Server: SimpleClicks / Jetty 9.4
Session-Cookie: AGENTSESSIONID
CORS: Access-Control-Allow-Credentials
Authentifizierung/

Form-basiertes Login. Passwort wahlweise plain oder MD5-HMAC mit Digest aus /json/backend/hmac.js. Session-Cookie: AGENTSESSIONID.

  • POST /j_security_check — Login (j_username, j_password, j_passwordtype=plain|hmac)
  • GET /j_security_logout — Logout
  • GET /j_security_validate — Session prüfen
  • GET /json/backend/hmac.js — MD5-Digest für HMAC-Login
  • GET /json/backend/getLogin — Rechte und Profil des aktuellen Users
  • GET /json/backend/systemInfo — OS, Java, Package-Versionen
  • GET /json/backend/browserLanguage — Sprach-Handshake
Agent & Fernwartung/json/agents
  • POST /json/agents/kfsDeepLink — Kyocera Fleet Services Deep-Link
  • POST /json/agents/ersDeepLink — ERS Deep-Link
  • GET /json/agents/sdsDeviceFeatures — SDS-Gerätefunktionen
  • GET /json/agents/sdsEvents — SDS-Events
  • GET /json/agents/sdsFirmwareInfo — Firmware-Stand
  • POST /json/agents/sdsInstallDeviceFirmware — Firmware installieren
  • POST /json/agents/sdsPowerCycleDevice — Gerät neu starten
  • POST /json/agents/sdsRemoteEws — Embedded Webserver remote öffnen
  • GET /json/agents/sdsGetDeviceAdminCredentials
  • POST /json/agents/sdsSetDeviceAdminCredentials
  • GET /json/agents/sdsGetGlobalAdminCredentials
  • POST /json/agentsData/doWalk — SNMP-Walk auslösen
Geräte (Devices)/json/devices
  • GET /json/devices/printDevicesPaging — Druckerliste (paginiert)
  • GET /json/devices/foundPrintDevicesPaging — gefundene Drucker
  • GET /json/devices/foundOtherDevicesPaging — sonstige Geräte
  • GET /json/devices/missingPrintDevicesPaging — nicht erreichbare
  • GET /json/devices/getDevice — Gerätedetails
  • POST /json/devices/addDevice — Gerät hinzufügen
  • POST /json/devices/swapDevice — Gerät tauschen
  • POST /json/devices/importDeviceList — Bulk-Import
  • GET /json/devices/exportDeviceList — Export
  • GET /json/devices/deviceGroups — Gerätegruppen
  • POST /json/devices/createGroupsFromLocations
  • GET /json/devices/getGroupsFilter, getLocationsFilter, getManufacturersFilter, getModelsFilter, getContractNoFilter, getCostCentersFilter, getContactLocationsFilter — Filter-Optionen
  • GET /json/devices/inputTrays, outputTrays, tCounters — Geräte-Detaildaten
  • POST /json/devices/acceptLevel — Zählerwert bestätigen
Verbrauchsmaterial (Supplies)/json/devices
  • GET /json/devices/supplyParts, supplyPartsPaging — Supply-Teile
  • POST /json/devices/setTonerLevel — Toner-Level manuell setzen
  • POST /json/devices/forceTonerChange — Toner-Wechsel erzwingen
  • POST /json/devices/clearTonerChange — Wechsel-Markierung entfernen
  • POST /json/devices/forceTonerOrder — Bestellung erzwingen
  • POST /json/devices/cancelTonerOrder, clearTonerOrder — Bestellung abbrechen/räumen
  • POST /json/devices/importSuppliesList, cleanSuppliesList — Supplies-Listen
  • GET /json/devices/exportSuppliesList
Kontakte, Kunden, Empfänger/json/master/contacts
  • GET /json/master/contacts/customer, client, locations, logins
  • GET /json/master/contacts/recipients, recipientGroups
  • POST /json/master/contacts/importRecipients, importLocationList
  • GET /json/master/contacts/exportRecipientsList, exportLocationList
  • POST /json/master/contacts/createRecipientGroupsFromDeviceGroups
  • POST /json/master/contacts/changePwd — Passwort ändern
  • POST /json/master/contacts/setupBrotherPrintSmart, removeBrotherPrintSmart
Enums (Auswahllisten)/json/master/enums

Reine Nachschlage-Endpunkte, meist beim Öffnen der Konfigurationsdialoge geladen.

  • GET /json/master/enums/snmpVersions — V1, V2c, V2c_V1, V3
  • GET /json/master/enums/snmpConfigs — vorhandene SNMP-Profile
  • GET /json/master/enums/smtpTransports — SMTP, SSL, TLS, TLS/SSL, Office365, …
  • GET /json/master/enums/mailStoreTypes, privacyProtocols, syncModes
  • GET /json/master/enums/recipientTypes, recipientGroups(*)
  • GET /json/master/enums/tonerThresholdsOrder(Group|Device), tonerThresholdsRequest(Group|Device), tonerThresholdsPackOrder(Group|Device)
  • GET /json/master/enums/supplyEventLevels(Group|Device), thresholdTypes
  • GET /json/master/enums/locationsGroup, scanGroupHandling
Netzwerk/json/network
  • POST /json/network/configInterface — Interface konfigurieren
  • POST /json/network/runNetworkScan — Netzwerk-Scan starten
  • POST /json/network/sendTestMail — SMTP testen
  • POST /json/network/sendTicketMail — Ticket-Mail senden
  • POST /json/network/testMailStore — Mail-Store testen
Benachrichtigungen/json/notifications
  • GET /json/notifications/ — Übersicht
  • GET /json/notifications/exportCounterClearing
  • GET /json/notifications/exportCounterNotification
  • GET /json/notifications/exportSuppliesNotification
  • GET /json/notifications/exportSuppliesOrders
Statistiken & Reports/json/statistics
  • GET /json/statistics/counterDaily, counterHourly, counterHistory, counterLevelHistory — Zählerverläufe
  • GET /json/statistics/counterRatios, tonerChangeRatio, tonerOrderRatio, manufacturerRatio, modelRatio — Verhältniskennzahlen
  • GET /json/statistics/levelHistory, levelGraphicalHistory — Füllstandsverlauf
  • GET /json/statistics/alertHistory, changeHistory, events — Ereignisse
  • GET /json/statistics/tickets, getOrders, orderHistory — Aufträge/Tickets
  • GET /json/statistics/getHTMLTicket?agentId=… — Ticket als HTML
  • GET /json/statistics/totalDevices, tCounterNames
  • GET /json/statistics/exportAlertHistory, exportChangeHistory, exportCounterHistory, exportCounterLevelHistory, exportEvents, exportLevelHistory, exportOrderHistory, exportOrders — CSV-Exports
Definitionen (Geräteprofile)/json/definition
  • GET /json/definition/getManufacturers, getModels, getModelsEnum
  • POST /json/definition/updateDevice, updateDeviceFull — Modell aktualisieren
  • POST /json/definition/copyDefinition — Definition kopieren
  • POST /json/definition/uploadModelFile — Modelldatei hochladen
  • POST /json/definition/doWalk, getWalk — SNMP-Walk gegen Definition
  • POST /json/definition/clearCounters
System/json/system
  • GET /json/system/agentInfo — Agent-Identität und Lizenzzähler
  • GET /json/system/agentServiceLinks — verknüpfte Services
  • GET /json/system/licenses — Lizenzliste
  • POST /json/system/addLicenseKey — Lizenz einspielen
  • GET /json/system/contract — Kontingent (mono/color)
  • GET /json/system/configSet, thinConfigSet — Konfigurations-Sets
  • GET /json/system/networkConfig, snmpConfig, smtpConfig, updateConfig, notificationConfig, eventConfig, trackingConfig, syncConfig, databaseConfig, backupConfig, supplyChangeSettings
  • GET /json/system/tonerThresholds — Schwellenwert-Regeln
  • GET /json/system/alertSets, alertSetEntries — Alarmregelwerke
  • GET /json/system/dataStoreConfigs, testStoreConfig
  • POST /json/system/runBackup, migrateStore, syncAgentData
  • GET /json/system/syncAgentDataDownload
  • GET /json/system/htmlTemplate, loadTemplates, exportTemplates
  • POST /json/system/loadBrandingset, loadConfigset, loadDataExport, loadUpdate
  • GET /json/system/thinAgentClients, thinAgentSetup
  • POST /json/system/generateCert, uploadCert
  • POST /json/system/restartService, stopBackend
  • GET /json/system/getLog?logfile=…&breakcache=… — Log lesen
  • GET /json/system/getFile?agentId=… — Datei-Download
  • GET /json/system/qrimage.png?agentId=… — QR-Code für Agent
  • GET /json/system/importIpRangeList, exportIpRangeList
Thin-Agent/json/thinagent

Leichter Remote-Agent auf Client-Seite (thinAgentEnabled im Lizenzmodell).

  • POST /json/server/thinAgentSetup
  • POST /json/thinagent/definition/doWalk
  • GET /json/thinagent/definition/getWalk

Die Liste basiert auf den im ausgelieferten app.js referenzierten URLs (~205 Einträge). HTTP-Methoden sind aus dem Kontext (Lese- vs. Schreibaktion) abgeleitet und können vom Server je nach Endpunkt zusätzlich unterstützt werden.