API-Schlüssel

API-Schlüssel ermöglichen den programmatischen Zugriff auf die badges.ninja REST API. Nutze sie, um Erstellung, Ausstellung und Verwaltung von Auszeichnungen aus deinen eigenen Anwendungen zu automatisieren.

Einen API-Schlüssel erstellen

1. Öffne die Seite API-Schlüssel in der Seitenleiste.
2. Klicke auf API-Schlüssel erstellen. Ein Inline-Formular öffnet sich:

3. Gib dem Schlüssel einen Namen und klicke auf Erstellen. Der vollständige Schlüssel wird einmal in einem grünen Banner angezeigt:

4. Kopiere den Schlüssel sofort — er wird nur einmal angezeigt. Wenn du ihn verlierst, musst du einen neuen erstellen. Nachdem du das Banner geschlossen hast, wird nur das Präfix gespeichert:

Zugriffs-Scopes

Beim Erstellen eines Schlüssels kannst du ihn schreibgeschützt machen oder ihm vollen Zugriff belassen:

Scope	Erlaubt
Voller Zugriff (Standard)	Lesen und Schreiben — Daten auflisten und erstellen, ausstellen, aktualisieren oder löschen.
Schreibgeschützt	Nur sichere GET-Anfragen. Jede verändernde Anfrage (POST, PUT, PATCH, DELETE) wird mit 403 Forbidden abgelehnt.

Verwende einen schreibgeschützten Schlüssel für Integrationen, die deine Daten nur lesen müssen (Reporting, Dashboards, Backups), damit ein durchgesickerter Schlüssel nichts ändern kann. Setze im Erstellungsformular ein Häkchen bei Schreibgeschützter Schlüssel; schreibgeschützte Schlüssel zeigen in der Liste ein Read-only-Badge. Schlüssel, die vor Einführung der Scopes erstellt wurden, behalten vollen Zugriff.

Schlüsselformat

API-Schlüssel nutzen das Präfix bws_ gefolgt von einer 32-stelligen Hex-Zeichenfolge:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

API-Schlüssel in Anfragen verwenden

Füge den API-Schlüssel in jedem API-Request im X-Api-Key-Header mit:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

Siehe die Seite Authentifizierung für alle Details zur API-Authentifizierung.

Schlüssellimits pro Plan

Die Anzahl erstellbarer API-Schlüssel hängt von deinem Plan ab:

Plan	Limit an API-Schlüsseln
Free	1
Starter (9 $/Monat)	5
Pro (29 $/Monat)	20

Einen Schlüssel löschen

1. Öffne die Seite API-Schlüssel.
2. Finde den zu löschenden Schlüssel.
3. Klicke auf Löschen.
4. Bestätige die Löschung.

Nach dem Löschen funktioniert der Schlüssel sofort nicht mehr. Anwendungen, die ihn verwenden, erhalten Authentifizierungsfehler.