Authentification

Créez et gérez des jetons API pour authentifier vos requêtes

Toutes les requêtes API nécessitent un jeton API valide transmis dans l'en-tête Authorization. Les jetons sont des JWTs signés avec l'identité de votre compte, de sorte que tout accès aux données respecte automatiquement les autorisations de votre compte.

La création de jetons API nécessite un abonnement Ultra. Si vous n'en avez pas encore, consultez Abonnement pour passer à une formule supérieure.

Créer un jeton

Accéder aux clés API

Accédez à Paramètres > Clés API dans la barre latérale du tableau de bord.

Cliquer sur Créer un jeton

Cliquez sur le bouton Créer un jeton et donnez un nom descriptif à votre jeton (par exemple, « Home Assistant Integration » ou « Python Script »).

Copier votre jeton

Votre jeton sera affiché exactement une fois. Copiez-le et conservez-le en toute sécurité.

Vous ne pourrez plus revoir ce jeton. Si vous le perdez, vous devrez en créer un nouveau.

Utiliser votre jeton

Incluez le jeton comme jeton Bearer dans l'en-tête Authorization :

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();

Gérer les jetons

Afficher les jetons

La page des paramètres Clés API affiche tous vos jetons actifs :

  • Nom : le libellé que vous avez attribué
  • Créé : la date de création du jeton
  • Dernière utilisation : la dernière fois que le jeton a été utilisé pour effectuer une requête

Révoquer les jetons

Cliquez sur l'icône de la corbeille à côté d'un jeton pour le révoquer. La révocation est immédiate : les requêtes qui utilisent ce jeton reçoivent immédiatement des réponses 401 Unauthorized.

Révoquez et recréez régulièrement vos jetons, conformément aux bonnes pratiques de sécurité.

Limites des jetons

Vous pouvez avoir jusqu'à 5 jetons actifs à la fois. Si vous en avez besoin de davantage, révoquez d'abord un jeton inutilisé.

Réponses aux erreurs

StatutSignification
401Jeton manquant, invalide, expiré ou révoqué
403Le jeton est valide, mais vous n'avez pas l'autorisation d'effectuer cette action
404Ressource introuvable (ou inaccessible avec vos autorisations)
{
  "ok": false,
  "error": "Missing or invalid Authorization header"
}
{
  "ok": false,
  "error": "Token has been revoked"
}

Sur cette page