深度連結自動化
在 iPhone 或 iPad 上開啟 URL 以建立 REST API 自動化。
最後更新: 2026年10月31日
在 iPhone 或 iPad 上開啟 URL 以建立 REST API 自動化。深度連結不會設定其他目的地。
URL 格式
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export
url 為必填。請提供描述性的 name;若省略,預設為 Automation。參數名稱不區分大小寫。包含空格或保留字元的參數值請進行 URL 編碼。
在裝置上開啟該 URL,或在捷徑中使用 開啟 URL。啟用前請在 Health Auto Export 中檢查所建立的自動化。
參數參考
布林值接受 true/false、1/0 或 yes/no。先設定 datatype,再設定其資料專用選項;先設定 format,再設定 aggregatedata,以免後續選擇覆蓋先前設定。
基本設定
| 參數 | 值或含義 | 預設值 |
|---|---|---|
url |
裝置可到達的端點 URL | 必填 |
name |
非空自動化名稱 | Automation |
enabled |
啟用自動執行 | false |
datatype |
下列資料類型 | healthMetrics |
format |
json、csv、markdown 或 md |
json |
exportversion |
v1、v2、1 或 2 |
v2 |
period |
none、lastsync、today、yesterday、previous7days |
none |
requesttimeout |
整數秒,60–86400 | 60 |
headers |
逗號分隔的鍵/值對 | 無 |
batchrequests |
布林值;僅 JSON | false |
有效資料類型為 healthMetrics、workouts、symptoms、ecg、heartRateNotification、stateOfMind、cycleTracking 和 medications。心理狀態需要 iOS 18 或更高版本;藥物匯出需要 iOS 26 或更高版本。
日期範圍含義請參閱日期範圍。所有深度連結都建立 REST API 自動化;沒有 exportDestination 參數。
健康指標
| 參數 | 值或含義 | 預設值 |
|---|---|---|
metrics |
逗號分隔的精確指標名稱,例如 Step Count,Heart Rate |
所有可用指標 |
aggregatedata |
布林值;在支援時對個別讀數使用 false |
true |
interval |
none、minutes、hours、days、weeks、months、years |
none |
aggregatesleep |
控制睡眠彙總的布林值 | true |
metrics、aggregatedata 和 interval 適用於健康指標。選擇 CSV 會開啟彙總;個別讀數請使用 JSON。產生連結時請明確指定所需彙總。
體能訓練
| 參數 | 值或含義 | datatype=workouts 時的預設值 |
|---|---|---|
includeroutes |
布林值 | true |
includeworkoutmetadata |
布林值 | true |
workoutsmetadatainterval |
minutes 或 seconds;版本 2 |
minutes |
workouttypes |
逗號分隔的無符號 Apple 體能訓練類型識別碼 | 所有類型 |
不要在體能訓練連結中包含健康指標彙總選項。
節奏與通知
| 參數 | 值或含義 | 預設值 |
|---|---|---|
syncinterval |
minutes、hours、days、weeks |
minutes |
syncquantity |
正整數間隔數 | 5 |
notifyonupdate |
布林值;資料準備後通知 | true |
notifywhenrun |
布林值;目的地操作成功後通知 | true |
節奏仍受背景與健康資料限制約束;不是精確排程。
身份驗證與編碼
headers 值由交替的鍵和值組成:
headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY
每個鍵都需要值。逗號分隔成對,因此在此連結格式中請避免標頭值包含逗號。將空格編碼為 %20,加號為 %2B,與號為 %26。當端點 URL 自身帶有查詢參數時,請對完整端點 URL 進行編碼。
範例
選定指標,按小時彙總
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fmetrics&name=Steps%20and%20Heart%20Rate&datatype=healthMetrics&format=json&metrics=Step%20Count,Heart%20Rate&aggregatedata=true&interval=hours
含路線的體能訓練
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fworkouts&name=Workout%20Export&datatype=workouts&format=json&includeroutes=true&includeworkoutmetadata=true&exportversion=v2&workoutsmetadatainterval=minutes
兩個範例在您檢查並啟用自動化之前都會保持自動執行關閉。
疑難排解
- URL 或參數錯誤: 從最小 URL 開始,檢查拼寫和編碼,然後逐個加入選項。
- 無效指標: 使用精確指標名稱,包括空格和大小寫。
- 彙總錯誤: 僅在
datatype=healthMetrics時使用健康指標選項。 - 體能訓練設定錯誤: 將體能訓練選項與
datatype=workouts一起使用;按秒分組需要版本 2。 - 批次錯誤: 設定
format=json或停用batchrequests。 - 無效節奏/逾時: 使用支援的間隔、正數量,以及 60 到 86400 秒的逾時。
- URL 過長: 縮短指標/標頭列表,或在 App 中設定其餘設定。
建立後,使用 REST API — 匯出歷史或遺漏的資料 上傳選定範圍或檢查設定。