REST API-automatiseringsveiledning

REST API-automatiseringer lar deg automatisk eksportere helsedataene dine til enhver nettjeneste som aksepterer HTTP POST-forespørsler. Dette er ideelt for å integrere med tilpassede backends, tredjeparts-APIer eller webhooks.

Oversikt

REST API-automatiseringer sender helsedataene dine til et spesifisert URL-endepunkt ved hjelp av HTTP POST-forespørsler. Automatiseringen kan sende data i JSON- eller CSV-format, med konfigurerbare headers for autentisering og tilpassede metadata.

Bruksområder:

• Integrering med tilpassede backend-tjenester
• Sende data til webhooks
• Synkronisering med tredjeparts-APIer
• Bygge tilpassede dashboards eller analyseplattformer

Hovedfunksjoner:

• Støtter både JSON- og CSV-formater
• Tilpassede HTTP-headers for autentisering
• Konfigurerbar forespørsels-timeout
• Manuell eksport av historiske data

Begrensninger:

• Tilgang til helsedata: Apper har ikke tillatelse til å få tilgang til helsedata mens iPhone er låst. Automatiseringer kjører bare når enheten er ulåst. Dette er en begrensning fra Apple som ikke kan omgås. Mer informasjon

• Bakgrunnsbehandling: iOS begrenser bakgrunnsbehandling for å spare batteri. Automatiseringer er avhengige av Bakgrunnsoppdatering av app og kjører kanskje ikke med en gang hvis:

  • Bakgrunnsoppdatering av app er deaktivert for appen
  • Enheten er i lavstrømsmodus
  • Enheten har vært inaktiv over lengre tid
  • Systemressurser er begrenset
  • Flere apper konkurrerer om bakgrunnskjøringstid

Ytelse

Husk at iOS er optimalisert for kortvarige oppgaver på en mobil enhet med svært strenge ytelsesbegrensninger. Bakgrunnsoppgaver må vanligvis fullføres innen 30 sekunder og er begrenset i hvor mye minne de kan bruke. Health Auto Export gir stor fleksibilitet og tilpasning, og det krever at du forstår hvordan visse konfigurasjoner påvirker appens ytelse og resultater.

• Konfigurasjon: Automatiseringer som produserer store datamengder kan få systemet til å avslutte prosessen, slik at automatiseringer ikke kjører i bakgrunnen. Følgende konfigurasjoner kan produsere store datamengder:
  • Automatiseringer konfigurert til å eksportere alle helsemålinger.
    • Anbefaling: velg bare helsemålinger som har lagrede data i Apple Health, og bare data du faktisk planlegger å bruke. Selv tomme datatyper påvirker ytelsen. Du kan også vurdere å dele valgte helsemålinger på flere automatiseringer, noe som gjør det enklere for systemet å håndtere dem.
  • Automatiseringer med tidsgruppering i sekunder eller minutter, eller med Oppsummer data av. Slike detaljerte forespørsler kan ta lang tid å kjøre og kollidere med systembegrensninger.
    • Anbefaling: selv om det kan virke ideelt å ha de mest detaljerte dataene, vurder om det detaljnivået er nødvendig for hver måling eller datatype. Vurder flere automatiseringer med ulike innstillinger.
  • Ved eksport av utendørstreninger, som sykling, løping, fotturer osv. med rutedata, kan GPS og tilhørende helsemålingsdata produsere store nyttelaster.
• Nyttelaststørrelse: Spesielt ved REST API-eksport: store nyttelaster kan forårsake serverfeil. Sørg for at backenden din er konfigurert til å håndtere nyttelaster på muligens flere hundre megabyte for å unngå feil.
• Synkroniseringsfrekvens: Legg til Automatiseringer-widgeten på hjemskjermen for å bidra til at automatiseringer kjører vellykket i bakgrunnen (se Veiledning for oppsett av automatiseringer-widget).

Forutsetninger

• Et gyldig URL-endepunkt som aksepterer HTTP POST-forespørsler
• Autentiseringslegitimasjoner (hvis påkrevd av ditt endepunkt)
• Nettverksforbindelse for å nå ditt endepunkt

Konfigurasjon

Naviger til skjermen Automatiserte eksporter fra hovednavigasjonen, trykk deretter på "Ny automatisering" og velg "REST API" som Automatiserings type.

Automatiseringsnavn

Skriv inn et beskrivende navn for automatiseringen din (f.eks. "Min Backend API", "Webhook-integrasjon").

Varsler

Konfigurer når du vil motta varsler:

• Varsle ved cache-oppdatering - Motta et varsel når hurtiglagrede data oppdateres
• Varsle når den kjører - Motta et varsel hver gang automatiseringen utfører

URL-konfigurasjon

Skriv inn den fullstendige URL-en der du vil sende helsedataene dine. Dette bør være en fullstendig URL inkludert protokollen (http:// eller https://).

Eksempel-URLer:

• https://api.example.com/health-data
• https://webhook.site/your-unique-id
• http://localhost:3000/api/health

Merk: URL-en må være gyldig og tilgjengelig fra enheten din. Ugyldige URLer vil forhindre at automatiseringen kjører.

Forespørsels-timeout

Velg et timeout-intervall for HTTP-forespørsler. Dette bestemmer hvor lenge appen vil vente på et svar før forespørselen anses som mislykket.

HTTP-headers

Legg til tilpassede HTTP-headers for autentisering eller metadata. Vanlige bruksområder inkluderer:

• API-nøkler: X-API-Key: your-api-key
• Autorisasjonstokens: Authorization: Bearer your-token
• Innholdstype-overskrivelser: Content-Type: application/json

For å legge til headers:

1. Trykk på "Legg til headers"
2. Skriv inn header-nøkkelen i venstre felt
3. Skriv inn header-verdien i høyre felt
4. Gjenta for tilleggsheaders

Viktig: Hver header-nøkkel må ha en tilsvarende verdi. Tomme headers vil bli ignorert.

Datatypinnstillinger

Datatype

Velg hvilken type helsedata som skal eksporteres:

• Helsemålinger - Skritt, hjertefrekvens, søvn og andre helsemålinger
• Treninger - Trenings- og fitnessaktiviteter
• Symptomer - Helsesymptomer og tilstander
• EKG - Elektrokardiogramavlesninger
• Hjertefrekvensvarsler - Høye/lave hjertefrekvenshendelser
• Sinnstilstand - Humør- og mentale tilstandsposter (iOS 18.0+)
• Syklussporing - Menstruasjonssyklus- og reproduktiv helsedata
• Medisiner - Medisinlogger og overholdelse (iOS 26.0+)

Konfigurasjon av helsemålinger

Når Helsemålinger er valgt:

Velg helsemålinger - Velg hvilke spesifikke målinger som skal inkluderes. Du kan velge alle tilgjengelige målinger eller velge spesifikke.

Tips: Å velge bare målingene du trenger kan forbedre behandlingstiden og redusere datastørrelsen.

Foretrukne kilder - Konfigurer hvilke datakilder som har prioritet når flere kilder leverer samme måling.

Konfigurasjon av treninger

Når Treninger er valgt:

Inkluder rutdata - Slå PÅ for å inkludere ruter for treninger som har plasseringsdata.

Inkluder treningsmålinger - Slå PÅ for å inkludere helsemålinger samlet under treninger (hjertefrekvens, kalorier, etc.).

Tidsgruppering (treningsmålinger) - Når du bruker Eksportversjon 2 og Inkluder treningsmålinger er aktivert:

• Minutter - Grupperer treningsmålinger per minutt
• Sekunder - Grupperer treningsmålinger per sekund

Eksportinnstillinger

Eksportformat

Velg formatet for eksporterte data:

• JSON-format - Gir detaljerte datastrukturer med nestede objekter. Best for APIer, databaser og applikasjoner som trenger strukturerte data. JSON-format inkluderer mer detaljert informasjon for komplekse datatyper som søvnfaser og AFib-avlesninger.

• CSV-format - Gir tabelldata som enkelt kan importeres til regnearkapplikasjoner. Best for enkel dataanalyse eller når endepunktet ditt forventer CSV-data.

Merk: Content-Type-headeren settes automatisk til application/json for JSON-eksporter og multipart/form-data for CSV-eksporter.

Eksportversjon

Velg en Eksportversjon. Versjonering lar deg overgå mellom oppdaterte versjoner av eksporten i ditt eget tempo og minimerer endringer som bryter arbeidsflyter.

• Versjon 1 - Eldre format, bruk hvis du har eksisterende arbeidsflyter som er avhengige av dette formatet
• Versjon 2 - Nåværende format med forbedrede treningsdata og mer detaljerte metadataalternativer

Datoområde

Velg når data skal eksporteres:

• Standard - Synkroniserer data for hele forrige dag pluss data frem til nåværende dato og tid
• Siden siste synkronisering - Ved hver synkronisering eksporteres alle data siden siste gang eksporten ble kjørt frem til nåværende dato og tid
• I dag - Synkroniserer alle data for nåværende dato frem til nåværende tid
• I går - Synkroniserer alle data for hele forrige dag
• Siste 7 dager - Synkroniserer data for de siste syv dagene

Sammendrag data

Når du bruker JSON-format med datatype Helsemålinger, slå Sammendrag data PÅ eller AV.

• PÅ - Gir aggregerte datasammendrag
• AV - Gir desaggregerte data hvor mulig, viser individuelle datapunkter

Merk: Denne innstillingen gjelder bare JSON-format med Helsemålinger. Data aggregeres alltid når du bruker CSV-format eller når flere målinger er valgt.

Tidsgruppering

Når du bruker JSON-format med Sammendrag data aktivert, velg hvordan data skal aggregeres.

Merk: CSV-format aggregerer alltid data. Aggregering på minutt- og sekundnivå kan øke behandlingstiden og datastørrelsen betydelig.

Batch-forespørsler og store nyttelaster

Når du bruker JSON-format, slå Batch-forespørsler PÅ for å sende data i flere HTTP-forespørsler i stedet for én stor nyttelast.

• PÅ — Fordeler data over flere forespørsler. Bruk når endepunktet har størrelsesgrenser, tidsavbrudd på store bodyer eller du behandler data trinnvis.
• AV — Sender alle data i én forespørsel. Passer for mindre eksporter og enkle webhooks.

Når aktivere batch:

• Mange helsemetrikker valgt, lange datoperioder eller fin tidsgruppering (minutter/sekunder)
• Oppsummer data er AV og du eksporterer disaggregerte helsemetrikker
• Serveren returnerer feil eller tidsavbrudd på store POST-bodyer

Merknader:

• Batch-forespørsler gjelder bare REST API + JSON (ikke CSV).
• Batching reduserer nyttelast per forespørsel, men fjerner ikke behovet for å hente data på enheten; langsomme HealthKit-spørringer kan fortsatt vises som advarsler i aktivitetslogger. Se Langsomme spørringer i aktivitetslogger.

Synkroniseringsfrekvens

Konfigurer hvor ofte automatiseringen skal laste opp data:

Velg et tall og intervall.

Testing og verifisering

Verifisere dataformat

Appen inkluderer automatisk disse headerne i hver forespørsel:

• Content-Type - Satt basert på eksportformat
• automation-name - Navnet på automatiseringen din
• automation-id - Unik identifikator for automatiseringen
• automation-aggregation - Den valgte tidsgrupperingen
• automation-period - Det valgte datoområdet
• session-id - Unik identifikator for hver forespørsel

Feilsøking

Vanlige problemer

Data mottas ikke ved endepunkt

• Verifiser at endepunkt-URL-en er korrekt
• Sjekk at endepunktet ditt aksepterer POST-forespørsler
• Gjennomgå autentiseringsheaders
• Sjekk endepunktlogger for innkommende forespørsler
• Verifiser nettverksforbindelse

Tips og beste praksis

1. Automatisk synkronisering:

   • Lad enheten og bruk iPhone-speiling
     • Under lading setter iOS færre ytelsesbegrensninger, så data kan synkroniseres oftere
     • Med iPhone-speiling oppfører enheten seg som om den var ulåst. Health Auto Export får da tilgang til helsedata for automatiserte handlinger

2. Ytelse:

   • Bruk passende tidsgruppering for å balansere detalj vs. datastørrelse
   • Velg bare målingene du trenger

3. Pålitelighet:

   • Sett passende timeout-verdier basert på endepunktets responstid
   • Overvåk aktivitetslogger regelmessig

4. Dataformat:

   • Bruk JSON for strukturerte data og APIer
   • Bruk CSV for enkel dataanalyse eller regnearkintegrasjon
   • Vurder batch-forespørsler for store datasett eller separat behandling

Visning av aktivitetslogger

1. Trykk på Vis aktivitetslogger på konfigurasjonsskjermen for automatisering.
2. Gå gjennom kjøringer (gruppert, nyeste først), og utvid hendelser i hver kjøring.
3. Skill mellom advarsler (f.eks. treg helsedataforespørsel) og feil (HTTP-feil, tidsavbrudd eller HealthKit-lesefeil)—se Oversikt over automatiseringer — Aktivitetslogger.
4. Vellykkede REST-opplastinger viser ofte et sammendrag med format, datatype, eksportperiode og datoperiode i kjøringen.
5. Del (verktøylinje) eksporterer full diagnostisk ZIP av App-hendelseslogger for support (samme som Innstillinger → Avansert).
6. Tøm fjerner bare aktivitetshistorikken for denne automatiseringen.