API-Referenz

API-Übersicht

Lesezeit: ca. 1 min

API-Übersicht #

Einführung zur Novaplex API #

Die Novaplex API ermöglicht es dir, alle Funktionen programmatisch zu nutzen und in deine eigenen Anwendungen zu integrieren.

Authentifizierung #

Alle API-Anfragen erfordern einen API-Schlüssel, den du in deinem Novaplex-Dashboard generieren kannst.

API-Schlüssel generieren #

  1. Melde dich in deinem Novaplex-Dashboard an
  2. Navigiere zu Einstellungen > API-Schlüssel
  3. Klicke auf “Neuen Schlüssel erstellen”
  4. Wähle die entsprechenden Berechtigungen
  5. Kopiere den generierten Schlüssel (er wird nur einmal angezeigt!)

API-Schlüssel verwenden #

Füge den API-Schlüssel als Header zu deinen Anfragen hinzu:

Authorization: Bearer DEIN_API_SCHLÜSSEL

Endpunkte #

Benutzer #

Endpunkt Methode Beschreibung
/api/users GET Liste aller Benutzer abrufen
/api/users/:id GET Einzelnen Benutzer abrufen
/api/users POST Neuen Benutzer erstellen
/api/users/:id PUT Benutzer aktualisieren
/api/users/:id DELETE Benutzer löschen

Projekte #

Endpunkt Methode Beschreibung
/api/projects GET Liste aller Projekte abrufen
/api/projects/:id GET Einzelnes Projekt abrufen
/api/projects POST Neues Projekt erstellen
/api/projects/:id PUT Projekt aktualisieren
/api/projects/:id DELETE Projekt löschen

Fehlerbehandlung #

Die API gibt standardmäßig JSON-Antworten zurück. Bei Fehlern enthält die Antwort einen entsprechenden Statuscode und eine Fehlermeldung:

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Ungültiger API-Schlüssel"
  }
}

Rate Limiting #

Beachte, dass die API ein Rate Limiting von 100 Anfragen pro Minute pro API-Schlüssel hat.