OSIR · The AI-Native Domain Registrar

Help Center / api

API-Schlüssel verwalten

API-Schlüssel verwalten

API-Schlüssel authentifizieren Ihre Anwendungen bei unserer API. Erfahren Sie, wie Sie sie sicher erstellen und verwalten.

Einen API-Schlüssel erstellen

  1. Gehen Sie zu Einstellungen > API-Schlüssel
  2. Klicken Sie auf Neuen Schlüssel erstellen
  3. Geben Sie einen aussagekräftigen Namen ein
  4. Wählen Sie die Berechtigungen:
    • Read - Nur Ressourcen anzeigen
    • Write - Ressourcen erstellen und ändern
    • Delete - Ressourcen entfernen
  5. Legen Sie IP-Beschränkungen fest (optional, aber empfohlen)
  6. Klicken Sie auf Erstellen
  7. Kopieren Sie den Schlüssel sofort - er wird nicht erneut angezeigt!

Schlüsselformat

API-Schlüssel sehen so aus:

osir_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Bestandteile:

  • osir_ - Präfix, das unsere API kennzeichnet
  • live_ oder test_ - Umgebung
  • Zufällige Zeichenkette - Eindeutige Kennung

Ihren API-Schlüssel verwenden

Im Header (empfohlen)

curl -H "Authorization: Bearer osir_live_xxx" \
  https://api.osir.com/v1/domains

Im Query-String (nicht empfohlen)

https://api.osir.com/v1/domains?api_key=osir_live_xxx

Test- vs. Live-Schlüssel

Schlüsseltyp Zweck Echte Belastungen
Test Entwicklung und Tests Nein
Live Produktion Ja

Verwenden Sie während der Entwicklung immer Test-Schlüssel!

IP-Beschränkungen

Beschränken Sie die Schlüsselnutzung auf bestimmte IPs:

  1. Bearbeiten Sie Ihren API-Schlüssel
  2. Fügen Sie erlaubte IP-Adressen hinzu
  3. Speichern Sie die Änderungen

Beispiel:

  • 192.168.1.100 - Einzelne IP
  • 192.168.1.0/24 - IP-Bereich

Schlüsselberechtigungen

Berechtigung Erlaubte Aktionen
domains:read Domains auflisten, anzeigen
domains:write Domains registrieren, ändern
vps:read Server auflisten, anzeigen
vps:write Server erstellen, ändern
billing:read Rechnungen, Guthaben anzeigen
billing:write Zahlungsmethoden hinzufügen

Schlüssel widerrufen

Falls ein Schlüssel kompromittiert wurde:

  1. Gehen Sie zu API-Schlüssel
  2. Suchen Sie den Schlüssel
  3. Klicken Sie auf Widerrufen
  4. Der Schlüssel wird sofort ungültig

Bewährte Vorgehensweisen

  • Ein Schlüssel pro Anwendung - Einfacher zu widerrufen, falls nötig
  • IP-Beschränkungen verwenden - Begrenzen Sie das Risiko
  • Regelmäßig rotieren - Neue Schlüssel erstellen, alte widerrufen
  • Niemals Schlüssel committen - Verwenden Sie Umgebungsvariablen
  • Nutzung überwachen - Prüfen Sie die API-Protokolle auf ungewöhnliche Aktivitäten

Umgebungsvariablen

Speichern Sie Schlüssel sicher:

# .env-Datei (niemals committen!)
OSIR_API_KEY=osir_live_xxx

// Im Code verwenden
const apiKey = process.env.OSIR_API_KEY