Autenticación¶
Todas las solicitudes a la API Health Fitness requieren autenticación mediante clave de API. Su clave de API permite al sistema:
- Identificar y autorizar su aplicación
- Rastrear el uso y el límite
- Garantizar el acceso seguro a datos de salud y fitness sensibles
⚠️ Mantenga su clave de API confidencial. No la exponga públicamente ni la incluya en el código del lado del cliente.
Tipos de Usuarios (Solo Plataforma HefitAPI)¶
Cada cliente (administrador) puede crear dos tipos de usuarios en la plataforma HefitAPI:
- Usuario Desarrollador
- Creado por el cliente (administrador) para acceder a los puntos finales de la API.
- Solo puede utilizar las funciones de la API; todas las llamadas a la API se facturan al cliente administrador.
-
Los usuarios desarrollador realizan llamadas a la API utilizando su propia clave de API, al igual que el administrador.
-
Usuario de Finanzas
- Creado por el cliente (administrador) para gestionar las operaciones financieras.
- Puede ver la facturación, reabastecer los créditos de la API y supervisar el uso para el cliente/organización.
- No puede realizar llamadas a la API a los puntos finales; la clave de API de finanzas está restringida al acceso de facturación.
⚠️ Estos roles y restricciones son específicos para la plataforma HefitAPI.
Cómo obtener su clave de API¶
- Inscríbase o inicie sesión en el Panel de Control de la API Health Fitness.
- Navegue a Claves de API en la configuración de su cuenta.
- Genere una nueva clave de API para su aplicación o usuario.
- Copie la clave y guárdela de forma segura.
Cómo utilizar su clave de API¶
Autenticación mediante encabezado (Recomendado)¶
Incluya su clave de API en el encabezado de la solicitud:
curl -X GET "https://api.hefitapi.com/api/v1/bmi?weight=81&height=177" \
-H "X-API-Key: YOUR_API_KEY"
Autenticación mediante parámetro de consulta (Opcional)¶
También puede enviar la clave de API como un parámetro de consulta:
⚠️ La autenticación mediante parámetro de consulta es menos segura que la autenticación mediante encabezado. Úsela solo para pruebas o scripts del lado del servidor.
Método de RapidAPI¶
También puede acceder a la API clásica de Cálculo de Salud a través de 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"
⚠️ Nota: Las nuevas funciones de la API Health Fitness v1.0.0 (más de 35 nuevos puntos finales, soporte para 8 idiomas) no están disponibles a través de RapidAPI. Utilice la API principal en https://api.hefitapi.com para todos los puntos finales y el soporte completo de idiomas.
Mejores prácticas¶
- Nunca codifique las claves de API en aplicaciones del lado del cliente o repositorios públicos.
- Rote las claves de API regularmente por motivos de seguridad.
- Utilice claves separadas para los entornos de desarrollo, pruebas y producción.
- Supervise su uso de la API a través del Panel de Control para evitar alcanzar los límites.
- Asegúrese de que se utilice HTTPS para todas las solicitudes de la API para proteger la clave de la API en tránsito.
Ejemplo de solicitud¶
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"
Ejemplo de respuesta¶
{
"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
}
}
Notas¶
- Cada punto final requiere una clave de API válida.
- Las claves inválidas o faltantes devolverán una respuesta
401 Unauthorized - Las claves de API están vinculadas a su plan de cuenta; consulte su límite para solicitudes disponibles.
- Los puntos finales v1.0.0 no son compatibles con RapidAPI y requieren acceso directo a https://api.hefitapi.com.
- Los usuarios desarrollador pueden realizar llamadas a la API; los usuarios de finanzas no pueden acceder a los puntos finales de la API y están restringidos a la facturación únicamente.