Otomatisasi Deep Link

Buat otomatisasi REST API dengan membuka URL di iPhone atau iPad Anda. Deep link tidak mengonfigurasi tujuan lain.

Format URL

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

url wajib. Berikan name yang deskriptif; jika dihilangkan, default-nya adalah Automation. Nama parameter tidak peka huruf besar/kecil. Enkode URL nilai parameter yang berisi spasi atau karakter cadangan.

Buka URL di perangkat Anda, atau gunakan Buka URL di Pintasan. Tinjau otomatisasi yang dibuat di Health Auto Export sebelum mengaktifkannya.

Referensi parameter

Boolean menerima true/false, 1/0, atau yes/no. Atur datatype sebelum opsi spesifik datanya, dan format sebelum aggregatedata, agar pilihan nanti tidak menggantikan pengaturan sebelumnya.

Pengaturan dasar

Parameter	Nilai atau arti	Default
url	URL titik akhir yang dapat dijangkau dari perangkat Anda	Wajib
name	Nama otomatisasi tidak kosong	Automation
enabled	Aktifkan proses otomatis	false
datatype	Jenis data yang tercantum di bawah	healthMetrics
format	json, csv, markdown, atau md	json
exportversion	v1, v2, 1, atau 2	v2
period	none, lastsync, today, yesterday, previous7days	none
requesttimeout	Detik bilangan bulat, 60–86400	60
headers	Pasangan kunci/nilai dipisahkan koma	Tidak ada
batchrequests	Boolean; hanya JSON	false

Jenis data yang valid adalah healthMetrics, workouts, symptoms, ecg, heartRateNotification, stateOfMind, cycleTracking, dan medications. Keadaan Pikiran memerlukan iOS 18 atau lebih baru; ekspor obat memerlukan iOS 26 atau lebih baru.

Untuk arti rentang tanggal, lihat Rentang tanggal. Semua deep link membuat otomatisasi REST API; tidak ada parameter exportDestination.

Metrik kesehatan

Parameter	Nilai atau arti	Default
metrics	Nama metrik tepat dipisahkan koma, misalnya Step Count,Heart Rate	Semua metrik yang tersedia
aggregatedata	Boolean; gunakan false untuk pembacaan individual jika didukung	true
interval	none, minutes, hours, days, weeks, months, years	none
aggregatesleep	Boolean yang mengontrol peringkasan tidur	true

metrics, aggregatedata, dan interval berlaku untuk metrik kesehatan. Pemilihan CSV mengaktifkan peringkasan; gunakan JSON untuk pembacaan individual. Tentukan peringkasan yang diinginkan secara eksplisit saat membuat tautan.

Latihan

Parameter	Nilai atau arti	Default saat datatype=workouts
includeroutes	Boolean	true
includeworkoutmetadata	Boolean	true
workoutsmetadatainterval	minutes atau seconds; Versi 2	minutes
workouttypes	Pengenal jenis latihan Apple unsigned dipisahkan koma	Semua jenis

Jangan sertakan opsi agregasi metrik kesehatan dalam tautan latihan.

Ritme dan notifikasi

Parameter	Nilai atau arti	Default
syncinterval	minutes, hours, days, weeks	minutes
syncquantity	Bilangan bulat positif jumlah interval	5
notifyonupdate	Boolean; beritahu setelah penyiapan data	true
notifywhenrun	Boolean; beritahu setelah tindakan tujuan berhasil	true

Ritme tetap tunduk pada batasan latar belakang dan data kesehatan; ini bukan jadwal yang tepat.

Autentikasi dan enkode

Nilai headers terdiri dari kunci dan nilai bergantian:

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

Setiap kunci memerlukan nilai. Koma memisahkan pasangan, jadi hindari nilai header yang berisi koma dalam format tautan ini. Enkode spasi sebagai %20, tanda plus sebagai %2B, dan ampersand sebagai %26. Enkode URL titik akhir lengkap saat memiliki parameter kueri sendiri.

Contoh

Metrik yang dipilih, diringkas per jam

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

Latihan dengan rute

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

Kedua contoh meninggalkan proses otomatis dinonaktifkan sampai Anda meninjau dan mengaktifkan otomatisasi.

Pemecahan masalah

• Kesalahan URL atau parameter: Mulai dengan URL minimal, periksa ejaan dan enkode, lalu tambahkan opsi satu per satu.
• Metrik tidak valid: Gunakan nama metrik yang tepat, termasuk spasi dan kapitalisasi.
• Kesalahan agregasi: Gunakan opsi metrik kesehatan hanya dengan datatype=healthMetrics.
• Kesalahan pengaturan latihan: Gunakan opsi latihan dengan datatype=workouts; pengelompokan detik memerlukan Versi 2.
• Kesalahan batching: Atur format=json atau nonaktifkan batchrequests.
• Ritme/timeout tidak valid: Gunakan interval yang didukung, kuantitas positif, dan timeout dari 60 hingga 86400 detik.
• URL terlalu panjang: Kurangi daftar metrik/header atau konfigurasikan pengaturan yang tersisa di aplikasi.

Setelah pembuatan, gunakan REST API — Mengekspor data historis atau yang terlewat untuk mengunggah rentang yang dipilih atau memeriksa penyiapan.

Dokumentasi terkait

• Panduan Otomatisasi REST API
• Ikhtisar Otomatisasi