Authentifizierung

Erstellen und verwalten Sie API-Tokens zur Authentifizierung Ihrer Anfragen

Für alle API-Anfragen ist ein gültiges API-Token erforderlich, das im Authorization-Header übergeben wird. Token sind JWTs, die mit der Identität Ihres Kontos signiert werden, sodass jeder Datenzugriff automatisch Ihre Kontoberechtigungen berücksichtigt.

Für die Erstellung von API-Tokens ist ein Ultra-Abonnement erforderlich. Falls Sie noch keins haben, besuchen Sie Abonnement, um ein Upgrade durchzuführen.

Token erstellen

Zu den API-Schlüsseln navigieren

Gehen Sie in der Dashboard-Seitenleiste zu Einstellungen > API-Schlüssel.

Auf Token erstellen klicken

Klicken Sie auf die Schaltfläche Token erstellen und geben Sie Ihrem Token einen aussagekräftigen Namen (z. B. „Home Assistant Integration“ oder „Python Script“).

Token kopieren

Ihr Token wird genau einmal angezeigt. Kopieren Sie es und bewahren Sie es sicher auf.

Sie können dieses Token nicht mehr sehen. Wenn Sie es verlieren, müssen Sie ein neues erstellen.

Token verwenden

Fügen Sie das Token als Bearer-Token in den Authorization-Header ein:

curl -X GET \
  https://dashboard.researchanddesire.com/api/v1/users \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

headers = {"Authorization": "Bearer YOUR_API_TOKEN"}
response = requests.get(
    "https://dashboard.researchanddesire.com/api/v1/users",
    headers=headers,
)
data = response.json()
const response = await fetch(
  "https://dashboard.researchanddesire.com/api/v1/users",
  {
    headers: { Authorization: "Bearer YOUR_API_TOKEN" },
  },
);
const data = await response.json();

Tokens verwalten

Tokens anzeigen

Auf der Einstellungsseite API-Schlüssel werden alle Ihre aktiven Tokens angezeigt:

  • Name — die von Ihnen zugewiesene Bezeichnung
  • Erstellt — wann das Token erstellt wurde
  • Zuletzt verwendet — wann das Token zuletzt für eine Anfrage verwendet wurde

Token widerrufen

Klicken Sie auf das Papierkorbsymbol neben einem Token, um es zu widerrufen. Der Widerruf erfolgt sofort – Anfragen, die dieses Token verwenden, erhalten unmittelbar Antworten mit 401 Unauthorized.

Widerrufen und erstellen Sie Tokens regelmäßig neu – eine bewährte Sicherheitsmaßnahme.

Token-Limits

Sie können bis zu 5 aktive Tokens gleichzeitig haben. Wenn Sie mehr benötigen, widerrufen Sie zunächst ein nicht verwendetes Token.

Fehlerantworten

StatusBedeutung
401Fehlendes, ungültiges, abgelaufenes oder widerrufenes Token
403Das Token ist gültig, aber Sie haben keine Berechtigung für diese Aktion
404Ressource nicht gefunden (oder mit Ihren Berechtigungen nicht zugänglich)
{
  "ok": false,
  "error": "Missing or invalid Authorization header"
}
{
  "ok": false,
  "error": "Token has been revoked"
}

Auf dieser Seite