API-Authentifizierung

Jede API-Anfrage muss mit einem API-Key authentifiziert werden, der im Entwickler-Dashboard erstellt wurde.

So funktionieren Keys

• Keys haben das Format qrc_, gefolgt von 64 Hexadezimalzeichen.
• Der vollständige Key wird einmal angezeigt – bei der Erstellung. Wir speichern nur einen SHA-256-Hash, sodass er später nie wiederhergestellt werden kann. Wenn Sie ihn verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.
• Sie können mehrere Keys erstellen (zum Beispiel einen pro Umgebung) und jeden davon unabhängig widerrufen.
• Keys werden ausschließlich im Dashboard erstellt und widerrufen; es gibt keinen API-Endpunkt für die Key-Verwaltung.

Key senden

Verwenden Sie den Authorization-Header mit dem Bearer-Schema:

POST /api/v1/qr HTTP/1.1
Host: www.qrcodegenius.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Die einzige Ausnahme ist GET /render: Dieser Endpunkt akzeptiert den Key auch als Query-Parameter ?key=, damit er direkt als Bildquelle verwendet werden kann.

Keys schützen

• Speichern Sie Keys in Umgebungsvariablen (zum Beispiel in einer .env-Datei), niemals im Quellcode oder in öffentlichen Repositories.
• Rufen Sie die API von Ihrem Backend auf, nicht aus Browsern oder Mobile-Apps.
• Wenn ein Key kompromittiert wurde, widerrufen Sie ihn sofort im Entwickler-Dashboard – der Widerruf wird umgehend wirksam.

Authentifizierungsfehler

• 401 Unauthorized – der Authorization-Header fehlt oder ist fehlerhaft, oder der Key ist ungültig oder widerrufen.
• 403 Forbidden – der Key ist gültig, aber Ihr Plan enthält die Funktion nicht (zum Beispiel erfordert die Bulk-Generierung Pro).
• 429 Too Many Requests – Ihr monatliches Kontingent und Ihre Credits sind aufgebraucht. Siehe Fehler und Rate-Limits.