Présentation de l'API

Accédez à vos données de Research and Desire par programmation avec l'API REST

Pour connecter les comptes d’autres personnes à votre produit, suivez Créer une application et les exemples de connexion. Les conventions ci-dessous s’appliquent aussi aux requêtes OAuth autorisées.

L'API Research and Desire vous permet d'accéder aux données de votre tableau de bord à partir d'applications externes, de scripts et d'intégrations. Chaque requête API respecte les autorisations de votre compte : vous ne pouvez accéder qu'aux données que vous êtes autorisé à consulter.

Créer des jetons API personnels nécessite un abonnement Ultra. Les demandes OAuth suivent un processus d’approbation distinct ; les restrictions existantes des produits restent applicables. En savoir plus sur les jetons personnels.

URL de base

Tous les points de terminaison de l'API sont disponibles sur :

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

Concepts clés

Authentification

Créez des jetons API et découvrez comment authentifier les requêtes.

Référence des points de terminaison

Parcourez tous les points de terminaison disponibles pour Users, DTT, LKBX et OSSM.

Comment ça marche

Créer un jeton API

Accédez à Paramètres > Clés API dans le tableau de bord et créez un nouveau jeton. Copiez-le immédiatement : il n'est affiché qu'une seule fois.

Effectuer des requêtes

Incluez votre jeton dans l'en-tête Authorization de chaque requête.

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

Analyser la réponse

Toutes les réponses suivent un format d'enveloppe JSON cohérent.

Format de réponse

Chaque réponse utilise la même enveloppe :

Succès:

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

Erreur:

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

Pagination

Les points de terminaison de listes prennent en charge la pagination via les paramètres de requête :

Paramètre	Par défaut	Max.	Description
`limit`	50	100	Nombre d'enregistrements à renvoyer
`offset`	0	-	Nombre d'enregistrements à ignorer

Les réponses paginées enveloppent le tableau de données avec des métadonnées de pagination :

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

Exemple : récupérer la deuxième page de 25 utilisateurs :

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

Limitation du débit

L'API n'applique pas actuellement de limites de débit strictes, mais veuillez respecter le volume de vos requêtes. Une utilisation excessive peut entraîner une limitation de débit dans de futures versions.

Autorisations et RLS

Votre jeton API hérite exactement des mêmes autorisations que votre compte de tableau de bord. Cela signifie :

Vous ne pouvez voir que vos propres appareils et les appareils partagés avec vous via des partenariats.
Les actions liées aux sessions de verrouillage respectent les autorisations du détenteur de clé
Les requêtes des utilisateurs renvoient uniquement les utilisateurs auxquels vous êtes lié

Traitez votre jeton API comme un mot de passe. Toute personne possédant votre jeton peut accéder à vos données. Si un jeton est compromis, révoquez-le immédiatement depuis Paramètres > Clés API.