API-Übersicht

Greifen Sie mit der REST-API programmgesteuert auf Ihre Daten von Research and Desire zu

Mit der Research and Desire API können Sie über externe Anwendungen, Skripte und Integrationen auf Ihre Dashboard-Daten zugreifen. Jede API-Anfrage berücksichtigt die Berechtigungen Ihres Kontos – Sie können nur auf Daten zugreifen, die Sie sehen dürfen.

Der API-Zugriff ist eine Ultra-Funktion. Sie benötigen ein aktives Ultra-Abonnement, um API-Token zu erstellen. Erfahren Sie mehr über Ultra.

Basis-URL

Alle API-Endpunkte sind verfügbar unter:

https://dashboard.researchanddesire.com/api/v1

Schlüsselkonzepte

Authentifizierung

Erstellen Sie API-Tokens und erfahren Sie, wie Sie Anfragen authentifizieren.

Endpunktreferenz

Durchsuchen Sie alle verfügbaren Endpunkte für Users, DTT, LKBX und OSSM.

Wie es funktioniert

Erstellen Sie ein API-Token

Gehen Sie im Dashboard zu Einstellungen > API-Schlüssel und erstellen Sie ein neues Token. Kopieren Sie es sofort – es wird nur einmal angezeigt.

Stellen Sie Anfragen

Fügen Sie Ihr Token in den Authorization-Header jeder Anfrage ein.

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://dashboard.researchanddesire.com/api/v1/users

Analysieren Sie die Antwort

Alle Antworten folgen einem einheitlichen JSON-Wrapper-Format.

Antwortformat

Jede Antwort verwendet denselben Wrapper:

Erfolg:

{
  "ok": true,
  "data": { ... }
}

Fehler:

{
  "ok": false,
  "error": "Human-readable error message"
}

Paginierung

Listen-Endpunkte unterstützen die Paginierung über Abfrageparameter:

Parameter	Standard	Max	Beschreibung
`limit`	50	100	Anzahl der zurückzugebenden Datensätze
`offset`	0	-	Anzahl der zu überspringenden Datensätze

Gepaginierte Antworten enthalten das Datenarray zusammen mit Paginierungsmetadaten:

{
  "ok": true,
  "data": {
    "data": [ ... ],
    "pagination": {
      "limit": 50,
      "offset": 0
    }
  }
}

Beispiel: Rufen Sie die zweite Seite mit 25 Benutzern ab:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  "https://dashboard.researchanddesire.com/api/v1/users?limit=25&offset=25"

Ratenbegrenzung

Die API erzwingt derzeit keine strengen Ratenbegrenzungen, aber gehen Sie bitte verantwortungsvoll mit Ihrem Anfragevolumen um. Übermäßige Nutzung kann in zukünftigen Versionen zu einer Drosselung führen.

Berechtigungen und RLS

Ihr API-Token erbt exakt dieselben Berechtigungen wie Ihr Dashboard-Konto. Das heißt:

Sie können nur Ihre eigenen Geräte und über Partnerschaften mit Ihnen geteilte Geräte sehen
Aktionen für Sperrsitzungen berücksichtigen die Berechtigungen des Schlüsselinhabers
Benutzerabfragen geben nur Benutzer zurück, mit denen Sie eine Verbindung haben

Behandeln Sie Ihr API-Token wie ein Passwort. Jeder mit Ihrem Token kann auf Ihre Daten zugreifen. Wenn ein Token gefährdet ist, widerrufen Sie es sofort über Einstellungen > API-Schlüssel.