Skip to content

API-Schlüssel

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

API-Schlüssel — Leerstand

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:

Schlüssel erstellen — Namensformular

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

Neu erstellter Schlüssel einmal eingeblendet

  1. 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:

Schlüsselliste mit maskiertem Präfix

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:

bash
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:

PlanLimit an API-Schlüsseln
Free1
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.

Bestätigungsdialog beim Schlüssellöschen — der Widerruf ist sofort wirksam

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

badges.ninja Documentation