System

Basis-URL: https://app.neuroflash.com/api/digital-twin-service

Systemzustandsprüfung

GET/health

Systemzustandsprüfungs-Endpunkt.

Gibt den Service-Zustand, den Namen, die Version und die Umgebung zurück.

Antwort

FeldTypBeschreibung

statusstringService-Zustandsstatus

servicestringService-Name

versionstringService-Version

environmentstringBereitstellungsumgebung

Beispiel

cURL

curl "https://app.neuroflash.com/api/digital-twin-service/health" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/health",
    headers={"Authorization": f"Bearer {token}"},
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/health`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

Go

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/health", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "status": "healthy",
  "service": "digital-twin-service",
  "version": "1.0.0",
  "environment": "local"
}

Statusprüfung

GET/status

Statusprüfungs-Endpunkt mit Datenbankverbindungstests.

Erfordert Admin-Rolle. Gibt Anzahl der Berechtigungen von MySQL und Umfragen von PostgreSQL zurück, um die Datenbankverbindung zu überprüfen.

Antwort

FeldTypBeschreibung

statusstringDienststatus

mysqlbooleanMySQL-Datenbankverbindung

postgresbooleanPostgreSQL-Datenbankverbindung

Beispiel

cURL

curl "https://app.neuroflash.com/api/digital-twin-service/status" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/status",
    headers={"Authorization": f"Bearer {token}"},
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/status`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

Go

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/status", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "status": "healthy",
  "mysql": false,
  "postgres": false
}

Leistungsmetriken abrufen

GET/v1/performance-metrics

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
page	integer	1	Seitennummer (1-basiert)
size	integer	20	Anzahl der Elemente pro Seite
minCreatedAt	string	—	Twins und Aufträge filtern, die am oder nach diesem Zeitstempel erstellt wurden (Standard: vor 10 Tagen)
maxCreatedAt	string	—	Twins und Aufträge filtern, die am oder vor diesem Zeitstempel erstellt wurden (Standard: keine Obergrenze)

Antwort

FeldTypBeschreibung

dataarray<object>

keystring

valueobject

descriptionstring

pageobjectPaginierungsmetadaten.

sizeintegerAnzahl der Elemente pro Seite

totalElementsintegerGesamtzahl der übereinstimmenden Elemente

totalPagesintegerGesamtzahl der Seiten

currentPageintegerAktuelle Seitennummer (1-basiert)

Beispiel

cURL

curl "https://app.neuroflash.com/api/digital-twin-service/v1/performance-metrics" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Python

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/digital-twin-service/v1/performance-metrics",
    headers={"Authorization": f"Bearer {token}"},
).json()

Node.js

const response = await fetch(
  `https://app.neuroflash.com/api/digital-twin-service/v1/performance-metrics`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

Go

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/digital-twin-service/v1/performance-metrics", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "data": [
    {
      "key": "string",
      "value": {},
      "description": "string"
    }
  ],
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "currentPage": 0
  }
}