開始使用

歡迎使用 Google Health API!

這項新 API 採用 Google OAuth,可提供更安全、易用且可擴充的解決方案,方便存取及管理健康資料。以下列舉幾項福利:

  • 強化安全性:新版 API 採用 Google 目前的安全性建議,以及 API 設計和實作的最佳做法,可降低出現安全漏洞的風險。

  • 一致性:新版 API 遵循現代 API 設計原則,提供更一致且直覺的開發人員體驗。

  • 前瞻性

    • 擴充性:新版 API 專為因應未來需求而設計,可支援不斷增加的使用者和資料類型。
    • 可維護性:採用標準化做法可簡化應用程式的維護和更新作業,進而減少技術債。
    • 存取新功能:遷移至新版 API 後,即可存取新功能,確保應用程式與時俱進,並享有最新技術優勢。
    • 法規遵循:新版 API 會配合 Google 最新的安全和隱私權標準更新,減少應用程式維持法規遵循狀態所需的工作量。
    • 資料隱私權:Google OAuth 系統的設計符合各項資料隱私權法規 (例如 GDPR 和 HIPAA),可減輕開發人員的法規遵循負擔。

如何開始?

開始開發前,請參閱開發人員檢查清單,瞭解整合 Google Health API 的步驟。

入門方式也取決於您是哪種開發人員。

新開發人員

如果您沒有使用 Google API 或 Google Cloud 的經驗,或是需要複習相關知識,最簡單快速的入門方式就是完成其中一個程式碼研究室。我們提供使用 Visual Studio Code 或 OAuth 2.0 Playground 的 REST 程式碼研究室,以及 gRPC 專屬的 Python 程式碼研究室,您可以在其中瞭解如何擷取用戶端存根,以及編譯通訊協定緩衝區定義。

REST 程式碼研究室 (VS Code) REST 程式碼研究室 (OAuth 2.0 Playground) gRPC 程式碼研究室 (Python)

Fitbit 開發人員

如果您是現有的 Fitbit Web API 開發人員,建議先參閱遷移指南。這份文件會列出 Fitbit Web API 和 Google Health API 的所有差異,並提供相關指引,協助您開始規劃遷移作業。

本指南也會重點介紹最佳做法和 UI 範例,協助引導使用者完成重新驗證程序。

完成後,請先完成程式碼研究室,或確認 Google Cloud 設定已完成,再開始使用其中一個資料型別指南進行開發。

閱讀遷移指南 完成 Google Cloud 設定

選擇通訊協定

Google Health API 同時支援 REST 和 RPC 通訊協定,可為開發人員提供可擴充的高效能基礎,以便整合健康資料。

REST

REST 是一種 API 設計方法,以標準網路概念和 JSON 等人類可讀取的格式為基礎。由於瀏覽器支援且廣為採用,因此特別適合建構公開 API 和網頁應用程式。這項服務的主要優勢在於簡單好用,方便外部開發人員存取。

gRPC

RPC 是一種高效能系統,使用稱為通訊協定緩衝區的精簡二進位格式,促進機器間的通訊。由於效率高且支援串流等進階功能,因此非常適合內部微服務、行動裝置與後端之間的通訊,以及即時更新。如果需要嚴格的介面合約,或是想提高效能,建議使用 RPC。

詳情請參閱「gRPC vs REST: Understanding gRPC, OpenAPI and REST and when to use them in API design」。

AI 輔助與開發人員工具

您可以在這個網站使用 Google 的 AI 助理 Gemini 和內建開發人員工具,加快 Google Health API 工作流程。瀏覽時,您可以使用資訊面板中的 Gemini Chat 和程式碼說明功能,摘要說明複雜的指南、釐清資料類型和範圍,或將程式碼範例改寫成您使用的語言。您也可以在 APIs Explorer 中測試即時要求,並使用 JSON 回應做為提示內容,產生剖析邏輯。

如果您使用 Antigravity、Cursor、Claude Code 或自訂代理等 AI 輔助工具進行開發,可以將任何頁面匯出為 Markdown,或整合 Developer Knowledge MCP 伺服器,讓環境直接存取 Google Health API 說明文件。使用這些工作流程產生用戶端程式碼或排解錯誤。詳情請參閱「AI 輔助和開發人員工具」。

資源

除了入門指南,這個網站也提供豐富的資源,協助您進行開發和遷移作業。

  • 支援:需要協助嗎?前往支援頁面,即可存取社群論壇和公開 Issue Tracker。
  • Google Health API Parity Tool:使用這項工具比較 Fitbit Web API 和 Google Health API 的端點和功能。此外,您也可以直接搭配 LLM 使用結構定義檔案,或將其做為偏好 AI 工具中 Agents.md 檔案的一部分。
  • API 參考資料:完成 REST 參考資料文件。