Zu Content springen
Deutsch
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

API-Zugangsdaten erstellen

API-Schlüssel, Client ID und Secret erzeugen und sicher aufbewahren

Mit API-Zugangsdaten greifen Ihre Skripte und Integrationen auf die OpusDNS-API zu, etwa für Domainverwaltung, DNS-Operationen und Automatisierung. Öffnen Sie in der linken Seitenleiste Entwickler > API Zugangsdaten.

Oben auf der Seite erklärt der Kasten API-Zugangsdaten Informationen (zum Aufklappen anklicken) die drei Werte, die Sie erhalten:

  • API-Schlüssel: Verwenden Sie ihn im HTTP-Header x-api-key, um direkt auf jeden Endpunkt zuzugreifen. Wird nur einmal angezeigt.
  • Client-ID: die eindeutige Kennung Ihrer Organisation für die OAuth-Authentifizierung.
  • Client-Secret: ein Geheimnis zur Authentifizierung Ihrer Anfragen. Wird nur einmal angezeigt.

 

API-Zugangsdaten erstellen

  1. Klicken Sie auf API-Zugangsdaten erstellen. Der gleichnamige Dialog öffnet sich.
  2. Geben Sie unter Name eine Bezeichnung ein (Pflichtfeld), zum Beispiel "Production API Key" oder "WHMCS-Integration", und optional eine Beschreibung.
  3. Wählen Sie eine Rolle (Pflichtfeld). Vorausgewählt ist Administrator. Nehmen Sie die Rolle mit den wenigsten Berechtigungen, die Ihre Integration braucht. Die Rolle gilt für den Schlüssel, unabhängig davon, welcher Benutzer ihn erstellt hat. Mehr dazu unter Rollen und Berechtigungen für Benutzer und API-Schlüssel.
  4. Optional: Legen Sie ein Ablaufdatum mit Datum und Uhrzeit fest. Lassen Sie es leer, wenn die Zugangsdaten nicht ablaufen sollen.
  5. Bestätigen Sie den Dialog.

 

Zugangsdaten sofort kopieren

Der Dialog API-Zugangsdaten erstellt zeigt API-Schlüssel, Client-ID und Client-Secret. Klicken Sie auf Alle Zugangsdaten kopieren, bewahren Sie die Werte sicher auf und klicken Sie dann auf Fertig.

Wichtig: API-Schlüssel und Client-Secret werden nur einmal angezeigt. Schließen Sie den Dialog, ohne sie zu kopieren, können Sie sie später nicht mehr abrufen und müssen neue Zugangsdaten erstellen.

 

Zugangsdaten verwenden

Option 1: API-Schlüssel. Senden Sie den Schlüssel im HTTP-Header jeder Anfrage:

x-api-key: your-api-key-here

Option 2: OAuth Client Credentials. Verwenden Sie Client-ID und Client-Secret im OAuth-2.0-Client-Credentials-Verfahren, um ein Zugriffstoken zu erhalten.

Details und Beispiele finden Sie in der API-Dokumentation.

 

Bestehende Zugangsdaten verwalten

Die Tabelle zeigt Name (mit der Beschreibung darunter), Status (Aktiv oder Widerrufen), Erstellt, Läuft ab ("Nie", wenn kein Datum gesetzt ist) und Zuletzt verwendet. Weitere Spalten wie API-Schlüssel-ID, Rolle und Client-ID blenden Sie über die Spaltenauswahl ein. Sie können die Liste durchsuchen und nach Status filtern.

  • Bearbeiten ändert nur Name und Beschreibung. Der Schlüssel selbst und seine Rolle bleiben unverändert. Für eine andere Rolle erstellen Sie neue Zugangsdaten.
  • Löschen fragt, was mit den Zugangsdaten geschehen soll:
    • Widerrufen: Die Zugangsdaten funktionieren sofort nicht mehr und bleiben mit dem Status Widerrufen in der Liste.
    • Endgültig löschen: Die Zugangsdaten funktionieren sofort nicht mehr und werden endgültig gelöscht. Das geht auch für bereits widerrufene Zugangsdaten.

Beide Aktionen lassen sich nicht rückgängig machen.

 

Zugriff nach IP beschränken

Für zusätzliche Sicherheit erlauben Sie den API-Zugriff nur von Ihren eigenen IP-Adressen. Mehr dazu unter API-Zugriff nach IP einschränken.

 

Häufige Fehler

  • Secret nicht kopiert: API-Schlüssel und Client-Secret werden nur einmal angezeigt.
  • Abgelaufene Zugangsdaten verwendet: Prüfen Sie die Spalte Läuft ab.
  • Bekannt gewordenen Schlüssel nicht widerrufen: Ist ein Schlüssel anderen bekannt geworden, widerrufen Sie ihn sofort und erstellen Sie einen neuen.
  • Zu viele Berechtigungen: Die Rolle von Zugangsdaten lässt sich später nicht ändern. Wählen Sie sie deshalb beim Erstellen sorgfältig.

Banner mit Link zur OpusDNS-Entwicklerdokumentation und Sandbox