Automatizace Deep Link

Vytvořte automatizaci REST API otevřením URL na iPhonu nebo iPadu. Deep linky nenakonfigurují jiné cíle.

Formát URL

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export

url je povinné. Poskytněte popisný name; pokud je vynechán, výchozí hodnota je Automation. Názvy parametrů nerozlišují velikost písmen. Hodnoty parametrů obsahující mezery nebo rezervované znaky URL-enkódujte.

Otevřete URL na zařízení, nebo použijte Otevřít URL ve Zkratkách. Před zapnutím prohlédněte vytvořenou automatizaci v Health Auto Export.

Reference parametrů

Booleovské hodnoty přijímají true/false, 1/0 nebo yes/no. Nastavte datatype před jeho datově specifickými možnostmi a format před aggregatedata, aby pozdější výběry nenahradily dřívější nastavení.

Základní nastavení

Parametr	Hodnoty nebo význam	Výchozí
url	URL koncového bodu dostupná z zařízení	Povinné
name	Neprázdný název automatizace	Automation
enabled	Povolit automatické běhy	false
datatype	Typ dat uvedený níže	healthMetrics
format	json, csv, markdown nebo md	json
exportversion	v1, v2, 1 nebo 2	v2
period	none, lastsync, today, yesterday, previous7days	none
requesttimeout	Celé sekundy, 60–86400	60
headers	Páry klíč/hodnota oddělené čárkami	Žádné
batchrequests	Boolean; pouze JSON	false

Platné typy dat jsou healthMetrics, workouts, symptoms, ecg, heartRateNotification, stateOfMind, cycleTracking a medications. Stav mysli vyžaduje iOS 18 nebo novější; exporty léků vyžadují iOS 26 nebo novější.

Významy časových období viz Časové období. Všechny deep linky vytvářejí automatizace REST API; parametr exportDestination neexistuje.

Zdravotní metriky

Parametr	Hodnoty nebo význam	Výchozí
metrics	Přesné názvy metrik oddělené čárkami, například Step Count,Heart Rate	Všechny dostupné metriky
aggregatedata	Boolean; použijte false pro jednotlivá čtení, kde jsou podporována	true
interval	none, minutes, hours, days, weeks, months, years	none
aggregatesleep	Boolean řídící shrnutí spánku	true

metrics, aggregatedata a interval platí pro zdravotní metriky. Výběr CSV zapíná shrnutí; pro jednotlivá čtení použijte JSON. Při generování odkazů zadejte požadované shrnutí explicitně.

Tréninky

Parametr	Hodnoty nebo význam	Výchozí při datatype=workouts
includeroutes	Boolean	true
includeworkoutmetadata	Boolean	true
workoutsmetadatainterval	minutes nebo seconds; Verze 2	minutes
workouttypes	Identifikátory typů tréninku Apple oddělené čárkami (unsigned)	Všechny typy

Do odkazu tréninku nezahrnujte možnosti agregace zdravotních metrik.

Rytmus a oznámení

Parametr	Hodnoty nebo význam	Výchozí
syncinterval	minutes, hours, days, weeks	minutes
syncquantity	Kladné celé číslo intervalů	5
notifyonupdate	Boolean; oznámit po přípravě dat	true
notifywhenrun	Boolean; oznámit po úspěšné akci cíle	true

Rytmus zůstává předmětem limitů na pozadí a zdravotních dat; není přesným plánem.

Autentizace a kódování

Hodnota headers sestává ze střídajících se klíčů a hodnot:

headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY

Každý klíč vyžaduje hodnotu. Čárky oddělují páry, proto se v tomto formátu odkazu vyhněte hodnotám hlaviček obsahujícím čárky. Mezery enkódujte jako %20, plusy jako %2B a ampersandy jako %26. Kompletní URL koncového bodu enkódujte, když má vlastní query parametry.

Příklady

Vybrané metriky, shrnuté hodinově

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

Tréninky s trasami

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

Oba příklady nechávají automatické běhy vypnuté, dokud automatizaci neprohlédnete a nezapnete.

Řešení problémů

• Chyba URL nebo parametru: Začněte s minimální URL, zkontrolujte pravopis a kódování a poté přidávejte možnosti jednotlivě.
• Neplatná metrika: Použijte přesný název metriky včetně mezer a velikosti písmen.
• Chyba agregace: Možnosti zdravotních metrik používejte pouze s datatype=healthMetrics.
• Chyba nastavení tréninku: Možnosti tréninku používejte s datatype=workouts; sekundové seskupení vyžaduje Verzi 2.
• Chyba dávkování: Nastavte format=json nebo vypněte batchrequests.
• Neplatný rytmus/časový limit: Použijte podporované intervaly, kladné množství a časový limit od 60 do 86400 sekund.
• URL je příliš dlouhá: Snižte seznam metrik/hlaviček nebo zbývající nastavení nakonfigurujte v aplikaci.

Po vytvoření použijte REST API — Export historických nebo zmeškaných dat k nahrání vybraného období nebo kontrole nastavení.

Související dokumentace

• Průvodce automatizací REST API
• Přehled automatizací