Automação com ligação profunda
Crie uma automação de API REST abrindo um URL no seu iPhone ou iPad.
Última atualização: 31 de outubro de 2026
Nesta página
Crie uma automação de API REST abrindo um URL no seu iPhone ou iPad. As ligações profundas não configuram outros destinos.
Formato de URL
com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export
url é obrigatório. Forneça um name descritivo; se omitido, o valor predefinido é Automation. Os nomes dos parâmetros não diferenciam maiúsculas. Codifique em URL os valores de parâmetro que contenham espaços ou caracteres reservados.
Abra o URL no seu dispositivo, ou use Abrir URLs nos Atalhos. Reveja a automação criada no Health Auto Export antes de a ativar.
Referência de parâmetros
Os booleanos aceitam true/false, 1/0 ou yes/no. Defina datatype antes das suas opções específicas de dados, e format antes de aggregatedata, para que as seleções posteriores não substituam definições anteriores.
Definições básicas
| Parâmetro | Valores ou significado | Predefinição |
|---|---|---|
url |
URL do endpoint acessível a partir do seu dispositivo | Obrigatório |
name |
Nome de automação não vazio | Automation |
enabled |
Ativar execuções automáticas | false |
datatype |
Tipo de dados listado abaixo | healthMetrics |
format |
json, csv, markdown ou md |
json |
exportversion |
v1, v2, 1 ou 2 |
v2 |
period |
none, lastsync, today, yesterday, previous7days |
none |
requesttimeout |
Segundos inteiros, 60–86400 | 60 |
headers |
Pares chave/valor separados por vírgulas | Nenhum |
batchrequests |
Booleano; apenas JSON | false |
Os tipos de dados válidos são healthMetrics, workouts, symptoms, ecg, heartRateNotification, stateOfMind, cycleTracking e medications. Estado de espírito exige iOS 18 ou posterior; as exportações de medicamentos exigem iOS 26 ou posterior.
Para o significado dos intervalos de datas, consulte Intervalo de datas. Todas as ligações profundas criam automações de API REST; não há parâmetro exportDestination.
Métricas de saúde
| Parâmetro | Valores ou significado | Predefinição |
|---|---|---|
metrics |
Nomes exatos de métricas separados por vírgulas, como Step Count,Heart Rate |
Todas as métricas disponíveis |
aggregatedata |
Booleano; use false para leituras individuais quando suportado |
true |
interval |
none, minutes, hours, days, weeks, months, years |
none |
aggregatesleep |
Booleano que controla o resumo do sono | true |
metrics, aggregatedata e interval aplicam-se a métricas de saúde. A seleção CSV ativa o resumo; use JSON para leituras individuais. Indique o resumo desejado de forma explícita ao gerar ligações.
Treinos
| Parâmetro | Valores ou significado | Predefinição quando datatype=workouts |
|---|---|---|
includeroutes |
Booleano | true |
includeworkoutmetadata |
Booleano | true |
workoutsmetadatainterval |
minutes ou seconds; Versão 2 |
minutes |
workouttypes |
Identificadores de tipo de treino da Apple sem sinal, separados por vírgulas | Todos os tipos |
Não inclua opções de agregação de métricas de saúde numa ligação de treino.
Cadência e notificações
| Parâmetro | Valores ou significado | Predefinição |
|---|---|---|
syncinterval |
minutes, hours, days, weeks |
minutes |
syncquantity |
Número inteiro positivo de intervalos | 5 |
notifyonupdate |
Booleano; notificar após preparar os dados | true |
notifywhenrun |
Booleano; notificar após uma ação bem-sucedida no destino | true |
A cadência continua sujeita aos limites de segundo plano e de dados de saúde; não é um horário exato.
Autenticação e codificação
O valor de headers consiste em chaves e valores alternados:
headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY
Cada chave exige um valor. As vírgulas separam os pares, pelo que evite valores de cabeçalho com vírgulas neste formato de ligação. Codifique espaços como %20, sinais de mais como %2B e ampersands como %26. Codifique o URL completo do endpoint quando tiver os seus próprios parâmetros de consulta.
Exemplos
Métricas selecionadas, resumidas por hora
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
Treinos com rotas
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
Ambos os exemplos deixam as execuções automáticas desativadas até rever e ativar a automação.
Resolução de problemas
- Erro de URL ou parâmetro: Comece com o URL mínimo, verifique a ortografia e a codificação e, depois, adicione opções uma a uma.
- Métrica inválida: Use o nome exato da métrica, incluindo espaços e maiúsculas.
- Erro de agregação: Use opções de métricas de saúde apenas com
datatype=healthMetrics. - Erro de definições de treino: Use opções de treino com
datatype=workouts; o agrupamento em segundos exige a Versão 2. - Erro de lotes: Defina
format=jsonou desativebatchrequests. - Cadência/tempo limite inválidos: Use os intervalos suportados, uma quantidade positiva e um tempo limite de 60 a 86400 segundos.
- URL demasiado longo: Reduza a lista de métricas/cabeçalhos ou configure o restante na aplicação.
Após a criação, use API REST — Exportar dados históricos ou omitidos para carregar um intervalo selecionado ou verificar a configuração.