Aller au contenu

Authentification

Toutes les requêtes adressées à l'API Health Fitness nécessitent une authentification via une clé API. Votre clé API permet au système de :

  • Identifier et autoriser votre application
  • Suivre l'utilisation et les quotas
  • Assurer un accès sécurisé aux données de santé et de fitness sensibles

⚠️ Conservez votre clé API confidentielle. Ne la divulguez pas publiquement ni ne l'intégrez pas dans le code côté client.

Types d'utilisateurs (Plateforme HefitAPI uniquement)

Chaque client (administrateur) peut créer deux types d'utilisateurs sur la plateforme HefitAPI :

  1. Utilisateur Développeur
  2. Créé par le client (administrateur) pour accéder aux points d'extrémité de l'API.
  3. Ne peut utiliser que les fonctionnalités de l'API ; toutes les appels à l'API sont facturés au client administrateur.

  4. Les utilisateurs développeurs effectuent des appels API en utilisant leur propre clé API, comme l'administrateur.

  5. Utilisateur Financier

  6. Créé par le client (administrateur) pour gérer les opérations financières.
  7. Peut visualiser les factures, ajouter des crédits API et surveiller l'utilisation pour le client/l'organisation.
  8. Ne peut pas effectuer d'appels API vers les points d'extrémité ; la clé API financière est limitée à l'accès aux factures.

⚠️ Ces rôles et restrictions sont spécifiques à la plateforme HefitAPI.

Obtenir votre clé API

  1. S'inscrire ou se connecter sur le Tableau de bord de l'API Health Fitness.
  2. Accéder à "Clés API" dans les paramètres de votre compte.
  3. Générer une nouvelle clé API pour votre application ou utilisateur.
  4. Copier la clé et la stocker en toute sécurité.

Comment utiliser votre clé API

Authentification via en-tête (Recommandé)

Inclure votre clé API dans l'en-tête de la requête :

curl -X GET "https://api.hefitapi.com/api/v1/bmi?weight=81&height=177" \
  -H "X-API-Key: YOUR_API_KEY"

Authentification via paramètre de requête (Facultatif)

Vous pouvez également envoyer la clé API en tant que paramètre de requête :

curl -X GET "https://api.hefitapi.com/api/v1/bmi?weight=81&height=177&apikey=YOUR_API_KEY"

⚠️ L'authentification via paramètre de requête est moins sécurisée que l'utilisation des en-têtes. Utilisez-la uniquement pour les tests ou les scripts côté serveur.

Méthode RapidAPI

Vous pouvez également accéder à l'API Health Calculator classique via RapidAPI :

curl -X GET "https://rapidapi.com/dakidarts-dakidarts-default/api/health-calculator-api" \
  -H "X-RapidAPI-Key: YOUR_RAPIDAPI_KEY" \
  -H "X-RapidAPI-Host: health-calculator-api.p.rapidapi.com"

⚠️ Note : Les nouvelles fonctionnalités de l'API Health Fitness v1.0.0 (plus de 35 nouveaux points d'extrémité, prise en charge de 8 langues) ne sont pas disponibles via RapidAPI. Utilisez l'API principale à l'adresse https://api.hefitapi.com pour tous les points d'extrémité et une prise en charge complète des langues.

Meilleures pratiques

  • Ne codez jamais de clés API dans les applications côté client ou les référentiels publics.
  • Faites pivoter régulièrement les clés API pour des raisons de sécurité.
  • Utilisez des clés distinctes pour les environnements de développement, de test et de production.
  • Surveillez votre utilisation de l'API via le Tableau de bord pour éviter d'atteindre les limites de quota.
  • Assurez-vous que HTTPS est utilisé pour toutes les requêtes API afin de protéger la clé API en transit.

Exemple de requête

curl -X GET "https://api.hefitapi.com/api/v1/tdee?weight=81&height=177&age=36&gender=male&activity_level=moderately_active" \
  -H "X-API-Key: YOUR_API_KEY"

Exemple de réponse

{
  "tdee": 2762.15,
  "bmr": 1782.03,
  "activity_multiplier": 1.55,
  "profile": {
    "age": 36,
    "weight_kg": 81.0,
    "height_cm": 177.0,
    "gender": "male",
    "activity_level": "moderately_active"
  },
  "language": "en",
  "_api_metadata_": {
    "endpoint_name": "tdee",
    "authenticated": true
  }
}

Notes

  • Chaque point d'extrémité nécessite une clé API valide.
  • Les clés invalides ou manquantes renverront une réponse 401 Unauthorized.
  • Les clés API sont liées à votre plan d'abonnement ; vérifiez votre quota pour les requêtes disponibles.
  • Les points d'extrémité v1.0.0 ne sont pas pris en charge via RapidAPI et nécessitent un accès direct à https://api.hefitapi.com.
  • Les utilisateurs développeurs peuvent effectuer des appels API ; les utilisateurs financiers ne peuvent pas accéder aux points d'extrémité et sont limités à la facturation uniquement.

Pages connexes