Central de ajuda HealthyApps
Português (Brasil)
Central de ajuda
Site principal ↗

Buscar tópicos de ajuda

Automação com link profundo

Crie uma automação de API REST abrindo uma URL no seu iPhone ou iPad.

Última atualização: 31 de outubro de 2026

Nesta página
Formato de URL
Referência de parâmetros Referência de parâmetros Configurações básicasMétricas de saúdeTreinosCadência e notificações
Autenticação e codificação
Exemplos Exemplos Métricas selecionadas, resumidas por horaTreinos com rotas
Solução de problemasDocumentação relacionada

Crie uma automação de API REST abrindo uma URL no seu iPhone ou iPad. Os links profundos 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 padrão é 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 a URL no seu dispositivo, ou use Abrir URLs no Atalhos. Revise a automação criada no Health Auto Export antes de habilitá-la.

Referência de parâmetros

Os booleanos aceitam true/false, 1/0 ou yes/no. Defina datatype antes de suas opções específicas de dados, e format antes de aggregatedata, para que as seleções posteriores não substituam configurações anteriores.

Configurações básicas

Parâmetro Valores ou significado Padrão
url URL do endpoint acessível a partir do seu dispositivo Obrigatório
name Nome de automação não vazio Automation
enabled Habilitar 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. Todos os links profundos criam automações de API REST; não há parâmetro exportDestination.

Métricas de saúde

Parâmetro Valores ou significado Padrã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 se aplicam 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 links.

Treinos

Parâmetro Valores ou significado Padrã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 em um link de treino.

Cadência e notificações

Parâmetro Valores ou significado Padrã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, então evite valores de cabeçalho com vírgulas neste formato de link. Codifique espaços como %20, sinais de mais como %2B e ampersands como %26. Codifique a URL completa do endpoint quando ela tiver 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é você revisar e habilitar a automação.

Solução de problemas

  • Erro de URL ou parâmetro: Comece com a URL mínima, 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 configuraçõ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=json ou desative batchrequests.
  • Cadência/tempo limite inválidos: Use os intervalos suportados, uma quantidade positiva e um tempo limite de 60 a 86400 segundos.
  • URL longa demais: Reduza a lista de métricas/cabeçalhos ou configure o restante no app.

Após a criação, use API REST — Exportar dados históricos ou omitidos para carregar um intervalo selecionado ou verificar a configuração.

Documentação relacionada