認証¶

Health Fitness API へのすべてのリクエストは、APIキーを使用した認証が必要です。APIキーを使用することで、システムは次のことができます。

• アプリケーションを特定および認証
• 使用状況とクォータを追跡
• 重要な健康およびフィットネスデータへの安全なアクセスを確保

⚠️ APIキーを秘密にしてください。公開したり、クライアントサイドのコードに埋め込んだりしないでください。

ユーザータイプ（HefitAPIプラットフォームのみ）¶

クライアント（管理者）は、HefitAPIプラットフォームで2種類のユーザーを作成できます。

1. 開発者ユーザー
2. APIエンドポイントへのアクセスをクライアント（管理者）が作成します。
3. API機能のみを使用できます。すべてのAPIリクエストは管理者クライアントに課金されます。

4. 開発者ユーザーは、管理者と同じように、自分のAPIキーを使用してAPI呼び出しを行います。

5. 財務ユーザー

6. クライアント（管理者）が財務業務を管理するために作成します。
7. 請求内容の確認、APIクレジットの充填、およびクライアント/組織の利用状況の監視が可能です。
8. APIエンドポイントへのAPI呼び出しはできません。財務APIキーは、請求へのアクセスに限定されています。

⚠️ これらの役割と制限は、HefitAPIプラットフォームに固有です。

自分のAPIキーを入手する方法¶

1. Health Fitness APIダッシュボード で登録またはログインします。
2. アカウント設定の下にある「APIキー」に移動します。
3. アプリケーションまたはユーザー用の新しいAPIキーを生成します。
4. キーをコピーして安全な場所に保存します。

自分のAPIキーを使用する方法¶

ヘッダー認証（推奨）¶

リクエストヘッダーにAPIキーを含めます。

クエリパラメータ認証（オプション）¶

APIキーをクエリパラメータとして送信することもできます。

⚠️ クエリパラメータ認証は、ヘッダー認証よりもセキュリティが低いです。テストやサーバーサイドスクリプトでのみ使用してください。

RapidAPIメソッド¶

Classic Health Calculator APIは、RapidAPIを通じてアクセスすることもできます。

⚠️ 注意：新しいv1.0.0 Health Fitness APIの機能（35+の新しいエンドポイント、8言語のサポート）は、RapidAPIでは利用できません。 すべての現在のエンドポイントと完全な言語サポートについては、https://api.hefitapi.com のメインAPIを使用してください。

最佳实践¶

• クライアントサイドのアプリや公開リポジトリにAPIキーをハードコーディングしないでください。
• セキュリティのために、APIキーを定期的にローテーションしてください。
• 開発、テスト、および本番環境にそれぞれ異なるキーを使用してください。
• ダッシュボード を使用してAPIの利用状況を監視し、クォータ制限に達しないようにしてください。
• APIキーを安全に転送するために、すべてのAPIリクエストでHTTPSを使用してください。

サンプルリクエスト¶

サンプルレスポンス¶

備考¶

• すべてのエンドポイントには、有効なAPIキーが必要です。
• 無効または欠落したキーは、エラー応答を返します。
• APIキーは、アカウントプランに関連付けられています。利用可能なリクエストのクォータを確認してください。
• v1.0.0のエンドポイントは、RapidAPIでサポートされておらず、https://api.hefitapi.com への直接アクセスが必要です。
• 開発者ユーザーはAPI呼び出しをすることができます。財務ユーザーはAPIエンドポイントへのアクセスができず、請求のみ可能です。

関連ページ¶

• Getting Started
• DCN API
• BMI API
• TDEE API