AIX Aleph API Dokumentation | Ahzami

AIX Aleph API Dokumentation

Version 2.5 | Letzte Aktualisierung: 07.04.2025

Übersicht

Die AIX Aleph API ermöglicht den sicheren Zugriff auf unsere Hybrid-Intelligenzplattform mit:

  • Echtzeit-Datenströmen aus Smart City Infrastrukturen
  • Vorhersagemodellen mit Quantum AI Unterstützung
  • IoT-Gerätesteuerung für Smart City Anwendungen
  • Historische Datenanalyse und Reporting
Hinweis: Für den vollen Funktionsumfang benötigen Sie entsprechende Zugriffsrechte. Wenden Sie sich an Ihren Account Manager für weitere Informationen.

Authentifizierung

Alle API-Anfragen erfordern einen gültigen JWT-Token, den Sie über den Authentifizierungsendpunkt erhalten.

POST /auth/token

Erhalten Sie einen Authentifizierungstoken für API-Zugriffe.

Parameter

ParameterTypBeschreibung
usernameStringIhr Client-Benutzername
passwordStringIhr API-Passwort

Beispielanfrage

curl -X POST https://api.ahzami.de/auth/token \
-H "Content-Type: application/json" \
-d '{"username":"your_username","password":"your_password"}'

Beispielantwort

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600
}

Verwenden Sie den erhaltenen Token in allen nachfolgenden Anfragen im Authorization Header:

Authorization: Bearer your_token_here

API Endpunkte

1. Echtzeit-Daten

GET /api/data/realtime

Ruft Echtzeitdaten von Sensoren und Systemen ab.

Query Parameter

ParameterTypBeschreibung
typeStringDatenart (z.B. "sensor", "traffic", "environment")
locationStringStandortkennung für die Datenabfrage

Beispielanfrage

curl -X GET "https://api.ahzami.de/api/data/realtime?type=sensor&location=city_center" \
-H "Authorization: Bearer your_token_here"

Beispielantwort

{
  "timestamp": "2025-04-07T14:23:45Z",
  "data": {
    "temperature": 22.5,
    "humidity": 60,
    "air_quality": 45,
    "location": "city_center"
  }
}

2. Historische Daten

GET /api/data/history

Ruft historische Daten für Analysen ab.

Query Parameter

ParameterTypBeschreibung
typeStringDatenart (z.B. "traffic", "energy")
start_dateString (YYYY-MM-DD)Startdatum der Abfrage
end_dateString (YYYY-MM-DD)Enddatum der Abfrage

Beispielanfrage

curl -X GET "https://api.ahzami.de/api/data/history?type=traffic&start_date=2025-01-01&end_date=2025-01-31" \
-H "Authorization: Bearer your_token_here"

Beispielantwort

{
  "data": [
    {
      "timestamp": "2025-01-01T08:00:00Z",
      "traffic_density": 320,
      "average_speed": 42.5
    },
    {
      "timestamp": "2025-01-01T09:00:00Z",
      "traffic_density": 450,
      "average_speed": 32.1
    }
  ]
}

3. Vorhersagen

POST /api/ai/prediction

Erstellt Vorhersagen basierend auf Eingabedaten.

Request Body

FeldTypBeschreibung
input_dataObjectEingabedaten für die Vorhersage

Beispielanfrage

curl -X POST "https://api.ahzami.de/api/ai/prediction" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json" \
-d '{
  "input_data": {
    "temperature": 22.5,
    "humidity": 60,
    "time_of_day": "morning"
  }
}'

Beispielantwort

{
  "prediction": {
    "traffic_delay": 15,
    "energy_demand": 2450,
    "confidence": 0.87
  }
}

Fehlerbehandlung

HTTP CodeFehlerBeschreibung
400Bad RequestUngültige Anfrageparameter
401UnauthorizedAuthentifizierung fehlgeschlagen
403ForbiddenKeine Berechtigung für diese Aktion
404Not FoundRessource nicht gefunden
429Too Many RequestsRate Limit überschritten
500Internal Server ErrorServerfehler - bitte Support kontaktieren

Rate Limits

Zum Schutz unserer Systeme gelten folgende Anfragebegrenzungen:

  • Standard: 1.000 Anfragen/Minute, 10.000 Anfragen/Tag
  • Enterprise: 5.000 Anfragen/Minute, 50.000 Anfragen/Tag

Bei Überschreitung erhalten Sie eine 429 Fehlermeldung. Bitte implementieren Sie eine Backoff-Strategie.

Support

Für technischen Support kontaktieren Sie bitte: