Authentifizierung¶
Alle Anfragen an die Health Fitness API erfordern eine Authentifizierung über einen API-Schlüssel. Ihr API-Schlüssel ermöglicht dem System:
- Die Identifizierung und Autorisierung Ihrer Anwendung
- Die Verfolgung der Nutzung und des Quotas
- Die Gewährleistung eines sicheren Zugriffs auf sensible Gesundheits- und Fitnessdaten
⚠️ Bewahren Sie Ihren API-Schlüssel geheim. Stellen Sie ihn nicht öffentlich zur Verfügung oder integrieren Sie ihn in Client-seitigen Code.
Benutzerarten (Nur HefitAPI Plattform)¶
Jeder Client (Administrator) kann auf der HefitAPI Plattform zwei Arten von Benutzern erstellen:
- Entwickler-Benutzer
- Von dem Client (Administrator) erstellt, um auf API-Endpunkte zuzugreifen.
- Kann nur API-Funktionen verwenden; alle API-Aufrufe werden dem Administrator-Client in Rechnung gestellt.
-
Entwickler-Benutzer verwenden ihren eigenen API-Schlüssel, genau wie der Administrator.
-
Finanz-Benutzer
- Von dem Client (Administrator) erstellt, um Finanztransaktionen zu verwalten.
- Kann Rechnungen einsehen, API-Credits aufstocken und die Nutzung für den Client/die Organisation überwachen.
- Kann keine API-Aufrufe an Endpunkte tätigen; der Finanz-API-Schlüssel ist auf den Zugriff für Rechnungsstellung beschränkt.
⚠️ Diese Rollen und Einschränkungen sind spezifisch für die HefitAPI Plattform.
Erhalten Sie Ihren API-Schlüssel¶
- Melden Sie sich bei Health Fitness API Dashboard an oder registrieren Sie sich.
- Navigieren Sie zu API-Schlüssel unter Ihren Kontoeinstellungen.
- Generieren Sie einen neuen API-Schlüssel für Ihre Anwendung oder Ihren Benutzer.
- Kopieren Sie den Schlüssel und speichern Sie ihn sicher.
So verwenden Sie Ihren API-Schlüssel¶
Header-Authentifizierung (Empfohlen)¶
Fügen Sie Ihren API-Schlüssel im Anfragetyp-Header hinzu:
curl -X GET "https://api.hefitapi.com/api/v1/bmi?weight=81&height=177" \
-H "X-API-Key: YOUR_API_KEY"
Query Parameter-Authentifizierung (Optional)¶
Sie können den API-Schlüssel auch als Query-Parameter senden:
⚠️ Query Parameter-Authentifizierung ist weniger sicher als Header-Authentifizierung. Verwenden Sie sie nur für Tests oder serverseitige Skripte.
RapidAPI-Methode¶
Sie können auch den klassischen Health Calculator API über RapidAPI aufrufen:
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"
⚠️ Hinweis: Die neuen Funktionen der v1.0.0 Health Fitness API (über 35 neue Endpunkte, 8 Sprachen) sind nicht über RapidAPI verfügbar. Verwenden Sie die Haupt-API unter https://api.hefitapi.com für alle aktuellen Endpunkte und vollständige Sprachunterstützung.
Best Practices¶
- Hardcodieren Sie niemals API-Schlüssel in Client-seitigen Apps oder öffentlichen Repositories.
- Rotieren Sie API-Schlüssel regelmäßig zur Sicherheit.
- Verwenden Sie separate Schlüssel für Entwicklungs-, Test- und Produktionsumgebungen.
- Überwachen Sie die API-Nutzung über das Dashboard, um die Quotas zu vermeiden.
- Stellen Sie sicher, dass HTTPS für alle API-Anfragen verwendet wird, um den API-Schlüssel während der Übertragung zu schützen.
Beispielanfrage¶
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"
Beispielantwort¶
{
"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
}
}
Anmerkungen¶
- Jeder Endpunkt erfordert einen gültigen API-Schlüssel.
- Ungültige oder fehlende Schlüssel geben eine
401 Unauthorized-Antwort zurück. - API-Schlüssel sind an Ihren Kontoplan gebunden; überprüfen Sie Ihre verfügbaren Anfragen.
- v1.0.0 Endpunkte sind nicht über RapidAPI verfügbar und erfordern direkten Zugriff auf https://api.hefitapi.com.
- Entwickler-Benutzer können API-Aufrufe tätigen; Finanz-Benutzer können keine API-Endpunkte aufrufen und sind auf Rechnungsstellung beschränkt.