API-overzicht

Krijg met de REST API programmatisch toegang tot uw gegevens van Research and Desire

Met de Research and Desire API heeft u toegang tot uw dashboardgegevens vanuit externe applicaties, scripts en integraties. Bij elk API-verzoek worden de rechten van uw account gerespecteerd: u heeft alleen toegang tot gegevens die u mag zien.

API-toegang is een Ultra-functie. U hebt een actief Ultra-abonnement nodig om API-tokens te maken. Meer informatie over Ultra.

Basis-URL

Alle API-eindpunten zijn beschikbaar op:

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

Sleutelconcepten

Hoe het werkt

Maak een API-token

Ga naar Instellingen > API-sleutels in het dashboard en maak een nieuw token. Kopieer het onmiddellijk; het wordt slechts één keer weergegeven.

Verzoeken doen

Neem uw token op in de Authorization-header van elk verzoek.

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

Analyseer het antwoord

Alle antwoorden volgen een consistent JSON-envelopformaat.

Antwoordformaat

Bij elk antwoord wordt dezelfde envelopstructuur gebruikt:

Succes:

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

Fout:

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

Paginering

Eindpunten voor lijsten ondersteunen paginering via queryparameters:

ParameterStandaardMaxBeschrijving
limit50100Aantal records dat moet worden geretourneerd
offset0-Aantal records dat moet worden overgeslagen

Gepagineerde antwoorden bevatten de data-array samen met pagineringsmetagegevens:

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

Voorbeeld: haal de tweede pagina van 25 gebruikers op:

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

Beperking van de verzoekfrequentie

De API hanteert momenteel geen strikte limieten voor het aantal verzoeken, maar houd uw verzoekvolume redelijk. Overmatig gebruik kan in toekomstige releases worden beperkt.

Machtigingen en RLS

Uw API-token neemt exact dezelfde machtigingen over als uw dashboardaccount. Dit betekent:

  • U kunt alleen uw eigen apparaten en apparaten die via partnerschappen met u zijn gedeeld zien
  • Acties voor slotsessies respecteren de machtigingen van de sleutelhouder
  • Gebruikersquery's retourneren alleen gebruikers waarmee u een verbinding heeft

Behandel uw API-token als een wachtwoord. Iedereen met uw token heeft toegang tot uw gegevens. Als een token is aangetast, trekt u deze onmiddellijk in via Instellingen > API-sleutels.

Op deze pagina