Autenticação¶

Todas as solicitações para a API Health Fitness requerem autenticação através da chave de API. Sua chave de API permite que o sistema:

Identifique e autorize sua aplicação
Rastreie o uso e o limite
Garanta o acesso seguro a dados de saúde e condicionamento físicos sensíveis

⚠️ Mantenha sua chave de API confidencial. Não a exponha publicamente nem a inclua no código do lado do cliente.

Tipos de Usuários (Plataforma HefitAPI)¶

Cada cliente (administrador) pode criar dois tipos de usuários na plataforma HefitAPI:

Usuário Desenvolvedor
Criado pelo cliente (administrador) para acessar os endpoints da API.
Só pode usar os recursos da API; todas as chamadas da API são cobradas para o cliente administrador.
Os usuários desenvolvedor usam sua própria chave de API, assim como o administrador.
Usuário Financeiro
Criado pelo cliente (administrador) para gerenciar operações financeiras.
Pode visualizar faturas, adicionar créditos à API e monitorar o uso para o cliente/organização.
Não pode fazer chamadas de API para os endpoints; a chave de API financeira está restrita ao acesso de faturamento.

⚠️ Essas funções e restrições são específicas para a plataforma HefitAPI.

Obtendo Sua Chave de API¶

Inscreva-se ou faça login no Painel da API Health Fitness.
Navegue para Chaves de API nas suas configurações de conta.
Gere uma nova chave de API para sua aplicação ou usuário.
Copie a chave e armazene-a com segurança.

Como Usar Sua Chave de API¶

Autenticação via Cabeçalho (Recomendado)¶

Inclua sua chave de API no cabeçalho da solicitação:

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

Autenticação via Parâmetro de Consulta (Opcional)¶

Você também pode enviar a chave de API como um parâmetro de consulta:

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

⚠️ A autenticação via parâmetro de consulta é menos segura do que a via cabeçalho. Use-a apenas para testes ou scripts no lado do servidor.

Método RapidAPI¶

Você também pode acessar a API Health Calculator clássica 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"

⚠️ Nota: Os recursos da nova API Health Fitness v1.0.0 (mais de 35 novos endpoints, suporte a 8 idiomas) não estão disponíveis via RapidAPI. Use a API principal em https://api.hefitapi.com para todos os endpoints e suporte total de idioma.

Melhores Práticas¶

Nunca codifique chaves de API em aplicativos do lado do cliente ou em repositórios públicos.
Rotacione as chaves de API regularmente para segurança.
Use chaves separadas para ambientes de desenvolvimento, teste e produção.
Monitore o uso da sua API através do Painel para evitar atingir os limites.
Certifique-se de que o HTTPS seja usado para todas as solicitações de API para proteger a chave de API em trânsito.

Exemplo de Solicitação¶

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"

Exemplo de Resposta¶

{
  "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 endpoint requer uma chave de API válida.
Chaves inválidas ou ausentes retornarão uma resposta 401 Unauthorized
As chaves de API estão vinculadas ao seu plano de conta; verifique seu limite para solicitações disponíveis.
Os endpoints v1.0.0 não são suportados via RapidAPI e requerem acesso direto a https://api.hefitapi.com.
Os usuários desenvolvedor podem fazer chamadas de API; os usuários financeiros não podem acessar os endpoints da API e estão restritos apenas ao faturamento.