Passwortgenerator API - Dokumentation

📋 Inhaltsverzeichnis

Übersicht
Endpoints
Passwort generieren
Passwort validieren
API Informationen
Error Handling
Sicherheit
Verwendungsbeispiele

Übersicht

Die Passwortgenerator API ist eine REST API für erweiterte Passwortgenerator-Funktionen mit umfassenden Validierungs- und Analysefunktionen.

💡 Hinweis: Die API ist öffentlich zugänglich und erfordert keine Authentifizierung. Verwenden Sie HTTPS in Produktionsumgebungen.

Base URL

/api.php

Endpoints Übersicht

Die API bietet folgende Endpoints:

POST /api.php?action=generate - Passwort generieren
POST /api.php?action=validate - Passwort validieren
GET /api.php?action=info - API Informationen

1. Passwort generieren

POST /api.php?action=generate

Generiert ein neues Passwort nach den angegebenen Kriterien.

Request Body (JSON)

{
  "length": 16,
  "uppercase": true,
  "lowercase": true,
  "numbers": true,
  "symbols": true,
  "excludeAmbiguous": false,
  "customSymbols": ""
}
            

Parameter

Name	Typ	Standard	Beschreibung
`length`	int	16	Passwortlänge (4-128)
`uppercase`	bool	true	Großbuchstaben (A-Z) einbeziehen
`lowercase`	bool	true	Kleinbuchstaben (a-z) einbeziehen
`numbers`	bool	true	Zahlen (0-9) einbeziehen
`symbols`	bool	true	Sonderzeichen einbeziehen
`excludeAmbiguous`	bool	false	Zweideutige Zeichen (0/O, 1/l) ausschließen
`customSymbols`	string	leer	Benutzerdefinierte Sonderzeichen

Response (Erfolg)

{
  "success": true,
  "password": "aB3$xY9@pQ2#mN",
  "length": 14,
  "strength": "Stark",
  "charset_size": 94,
  "complexity": 1.23e+27,
  "options": {
    "uppercase": true,
    "lowercase": true,
    "numbers": true,
    "symbols": true,
    "excludeAmbiguous": false,
    "customSymbols": ""
  }
}
            

Response (Fehler)

{
  "success": false,
  "error": "Passwortlänge muss zwischen 4 und 128 Zeichen liegen"
}
            

Beispiel mit cURL

curl -X POST http://example.com/api.php?action=generate \
  -H "Content-Type: application/json" \
  -d '{
    "length": 20,
    "uppercase": true,
    "lowercase": true,
    "numbers": true,
    "symbols": true
  }'
            

Beispiel mit JavaScript (Fetch)

fetch('/api.php?action=generate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    length: 20,
    uppercase: true,
    lowercase: true,
    numbers: true,
    symbols: true
  })
})
.then(response => response.json())
.then(data => console.log(data.password));
            

2. Passwort validieren

POST /api.php?action=validate

Validiert ein bestehendes Passwort und analysiert dessen Sicherheitsstärke.

Request Body (JSON)

{
  "password": "MyPassword123!"
}
            

Parameter

Name	Typ	Erforderlich	Beschreibung
`password`	string	Ja	Das zu validierende Passwort

Response (Erfolg)

{
  "success": true,
  "password": "MyPassword123!",
  "length": 14,
  "strength": "Stark",
  "score": 4,
  "characteristics": {
    "hasUppercase": true,
    "hasLowercase": true,
    "hasNumbers": true,
    "hasSymbols": true,
    "typeCount": 4
  },
  "recommendations": [
    "Passwort ist sicher!"
  ]
}
            

Stärkeskalen

Score 1 - Sehr schwach: Weniger als 8 Zeichen
Score 2 - Schwach: 8+ Zeichen mit wenigen Zeichentypen
Score 3 - Mittel: 12+ Zeichen mit mindestens 2 Zeichentypen
Score 4 - Stark: 16+ Zeichen mit mindestens 3 Zeichentypen
Score 5 - Sehr stark: 20+ Zeichen mit mindestens 3 Zeichentypen

Beispiel mit cURL

curl -X POST http://example.com/api.php?action=validate \
  -H "Content-Type: application/json" \
  -d '{"password":"MyPassword123!"}'
            

3. API Informationen

GET /api.php?action=info

Gibt Informationen über die API und alle verfügbaren Endpoints zurück.

Response

{
  "success": true,
  "name": "Passwortgenerator API",
  "version": "1.0.0",
  "endpoints": {
    "generate": { ... },
    "validate": { ... },
    "info": { ... }
  }
}
            

Error Handling

HTTP Status Codes

200 OK - Erfolgreiche Anfrage
405 Method Not Allowed - Falsches HTTP-Verb (z.B. GET statt POST)
400 Bad Request - Ungültige Parameter

Fehlerformat

{
  "success": false,
  "error": "Beschreibung des Fehlers"
}
            

Sicherheitsrichtlinien

HTTPS verwenden - Verwenden Sie immer HTTPS für produktive Umgebungen
Rate Limiting - Implementieren Sie Rate-Limiting in Ihrer Infrastruktur
CORS - Die API erlaubt CORS-Anfragen von überall (anpassbar)
Passwörter nicht speichern - Die API speichert generierte Passwörter nicht

Verwendungsbeispiele

1. Passwort generieren (einfach)

curl -X POST http://localhost/api.php?action=generate

2. Starkes Passwort generieren (20 Zeichen)

curl -X POST http://localhost/api.php?action=generate \
  -H "Content-Type: application/json" \
  -d '{"length": 20, "symbols": true}'
            

3. Passwort mit benutzerdefinierten Symbolen

curl -X POST http://localhost/api.php?action=generate \
  -H "Content-Type: application/json" \
  -d '{"length": 16, "customSymbols": "!@#$%"}'
            

4. Ohne zweideutige Zeichen

curl -X POST http://localhost/api.php?action=generate \
  -H "Content-Type: application/json" \
  -d '{"length": 16, "excludeAmbiguous": true}'
            

5. Nur Buchstaben und Zahlen

curl -X POST http://localhost/api.php?action=generate \
  -H "Content-Type: application/json" \
  -d '{
    "length": 16,
    "uppercase": true,
    "lowercase": true,
    "numbers": true,
    "symbols": false
  }'
            

🚀 Interaktive Beispiele

Möchten Sie die API direkt testen? Besuchen Sie unsere Beispiele-Seite, um die Endpoints interaktiv zu testen.