Vejledning til REST API-automatisering

REST API-automatiseringer giver dig mulighed for automatisk at eksportere dine sundhedsdata til enhver webtjeneste, der accepterer HTTP POST-anmodninger. Dette er ideelt til integration med brugerdefinerede backends, tredjeparts-API'er eller webhooks.

Oversigt

REST API-automatiseringer sender dine sundhedsdata til et specificeret URL-slutpunkt ved hjælp af HTTP POST-anmodninger. Automatiseringen kan sende data i JSON- eller CSV-format med konfigurerbare headere til autentificering og brugerdefinerede metadata.

Anvendelsestilfælde:

• Integration med brugerdefinerede backend-tjenester
• Afsendelse af data til webhooks
• Synkronisering med tredjeparts-API'er
• Opbygning af brugerdefinerede dashboards eller analyseplatforme

Nøglefunktioner:

• Understøtter både JSON- og CSV-formater
• Brugerdefinerede HTTP-headere til autentificering
• Konfigurerbar anmodnings-timeout
• Manuel eksport af historiske data

Begrænsninger:

• Adgang til sundhedsdata: Apps må ikke få adgang til sundhedsdata, mens iPhone er låst. Automatiseringer kører kun, når enheden er låst op. Dette er en begrænsning fra Apple, som ikke kan omgås. Flere oplysninger

• Baggrundsbehandling: iOS begrænser baggrundsbehandling for at spare batteri. Automatiseringer afhænger af Baggrundsopdatering af app, og kører måske ikke med det samme, hvis:

  • Baggrundsopdatering af app er deaktiveret for appen
  • Enheden er i strømbesparende tilstand
  • Enheden har været inaktiv i længere perioder
  • Systemressourcer er begrænsede
  • Flere apps konkurrerer om baggrundskørselstid

Ydeevne

Husk, at iOS er optimeret til kortvarige opgaver på en mobilenhed med meget stramme ydeevnebegrænsninger. Baggrundsopgaver skal typisk fuldføres inden for 30 sekunder og er begrænset i, hvor meget hukommelse de kan bruge. Health Auto Export giver stor fleksibilitet og tilpasning, og det kræver, at du forstår, hvordan visse konfigurationer påvirker appens ydeevne og resultater.

• Konfiguration: Automatiseringer, der producerer store datamængder, kan få systemet til at afslutte processen, så automatiseringer ikke kører i baggrunden. Følgende konfigurationer kan producere store datamængder:
  • Automatiseringer konfigureret til at eksportere alle sundhedsmålinger.
    • Anbefaling: vælg kun sundhedsmålinger, der har gemte data i Apple Health, og kun data, du faktisk planlægger at bruge. Selv tomme datatyper påvirker ydeevnen. Du kan også overveje at opdele valgte sundhedsmålinger på flere automatiseringer, hvilket gør det lettere for systemet at håndtere dem.
  • Automatiseringer med tidsgruppering i sekunder eller minutter, eller med Opsummer data slået fra. Sådanne detaljerede forespørgsler kan tage lang tid at køre og kollidere med systembegrænsninger.
    • Anbefaling: selvom det kan virke ideelt at have de mest detaljerede data, overvej om det detaljeniveau er nødvendigt for hver måling eller datatype. Overvej flere automatiseringer med forskellige indstillinger.
  • Ved eksport af udendørs træninger, såsom cykling, løb, vandring osv. med rutedata, kan GPS og tilhørende sundhedsmålingsdata producere store payloads.
• Payload-størrelse: Især ved REST API-eksport: store payloads kan forårsage serverfejl. Sørg for, at din backend er konfigureret til at håndtere payloads på muligvis flere hundrede megabyte for at undgå fejl.
• Synkroniseringsfrekvens: Tilføj Automatiserings-widgetten til din startskærm for at hjælpe med at sikre, at automatiseringer kører succesfuldt i baggrunden (se Guide til opsætning af automatiserings-widget).

Forudsætninger

• Et gyldigt URL-slutpunkt, der accepterer HTTP POST-anmodninger
• Autentificeringslegitimationsoplysninger (hvis påkrævet af dit slutpunkt)
• Netværksforbindelse til at nå dit slutpunkt

Konfiguration

Naviger til skærmen Automatiserede eksporter fra hovednavigationen, tryk derefter på Ny automatisering og vælg "REST API" som Automatiseringstype.

Automatiseringsnavn

Indtast et beskrivende navn til din automatisering (f.eks. "Min Backend API", "Webhook Integration").

Notifikationer

Konfigurer hvornår du vil modtage notifikationer:

• Giv besked ved cache-opdatering - Modtag en notifikation, når cachede data opdateres
• Giv besked når den kører - Modtag en notifikation, hver gang automatiseringen udfører

URL-konfiguration

Indtast den fulde URL, hvor du vil sende dine sundhedsdata. Dette skal være en komplet URL inklusive protokollen (http:// eller https://).

Eksempel-URL'er:

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

Bemærk: URL'en skal være gyldig og tilgængelig fra din enhed. Ugyldige URL'er forhindrer automatiseringen i at køre.

Anmodnings-timeout

Vælg et timeout-interval for HTTP-anmodninger. Dette bestemmer, hvor længe appen vil vente på et svar, før den betragter anmodningen som mislykket.

HTTP-headere

Tilføj brugerdefinerede HTTP-headere til autentificering eller metadata. Almindelige anvendelsestilfælde inkluderer:

• API-nøgler: X-API-Key: your-api-key
• Autorisationstokens: Authorization: Bearer your-token
• Indholdstypetilsidesættelser: Content-Type: application/json

For at tilføje headere:

1. Tryk på "Tilføj headere"
2. Indtast headernøglen i venstre felt
3. Indtast headerværdien i højre felt
4. Gentag for yderligere headere

Vigtigt: Hver headernøgle skal have en tilsvarende værdi. Tomme headere vil blive ignoreret.

Datatypeindstillinger

Datatype

Vælg hvilken type sundhedsdata der skal eksporteres:

• Sundhedsmålinger - Skridt, puls, søvn og andre sundhedsmålinger
• Træninger - Trænings- og fitnessaktiviteter
• Symptomer - Sundhedssymptomer og tilstande
• EKG - Elektrokardiogramaflæsninger
• Pulsbeskeder - Høje/lave pulshændelser
• Sindstilstand - Humør- og mentale tilstandsindtastninger (iOS 18.0+)
• Cyklussporing - Menstruationscyklus og reproduktive sundhedsdata
• Medicin - Medicinlogfiler og overholdelse (iOS 26.0+)

Konfiguration af sundhedsmålinger

Når Sundhedsmålinger er valgt:

Vælg sundhedsmålinger - Vælg hvilke specifikke målinger der skal inkluderes. Du kan vælge alle tilgængelige målinger eller vælge specifikke.

Tip: Valg af kun de målinger, du har brug for, kan forbedre behandlingstiden og reducere datastørrelsen.

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

Træningskonfiguration

Når Træninger er valgt:

Inkluder rutedata - Slå TIL for at inkludere ruter for træninger, der har lokationsdata.

Inkluder træningsmålinger - Slå TIL for at inkludere sundhedsmålinger indsamlet under træninger (puls, kalorier osv.).

Tidsgruppering (træningsmålinger) - Når du bruger eksportversion 2, og Inkluder træningsmålinger er aktiveret:

• Minutter - Grupperer træningsmålinger efter minut
• Sekunder - Grupperer træningsmålinger efter sekund

Eksportindstillinger

Eksportformat

Vælg formatet for dine eksporterede data:

• JSON-format - Giver detaljerede datastrukturer med indlejrede objekter. Bedst til API'er, databaser og applikationer, der har brug for strukturerede data. JSON-format inkluderer mere detaljeret information for komplekse datatyper som søvnfaser og AFib-aflæsninger.

• CSV-format - Giver tabeldata, der nemt kan importeres til regnearksapplikationer. Bedst til simpel dataanalyse eller når dit slutpunkt forventer CSV-data.

Bemærk: Content-Type-headeret indstilles automatisk til application/json for JSON-eksporter og multipart/form-data for CSV-eksporter.

Eksportversion

Vælg en eksportversion. Versionering giver mulighed for at skifte mellem opdaterede versioner af eksporten i dit eget tempo og minimerer brydende ændringer i arbejdsgange.

• Version 1 - Ældre format, brug hvis du har eksisterende arbejdsgange, der er afhængige af dette format
• Version 2 - Aktuelt format med forbedrede træningsdata og mere detaljerede metadataindstillinger

Datointerval

Vælg hvornår data skal eksporteres:

• Standard - Synkroniserer data for hele den foregående dag plus data op til den aktuelle dato og tid
• Siden sidste synkronisering - Ved hver synkronisering eksporteres alle data siden sidste gang eksporten kørte op til den aktuelle dato og tid
• I dag - Synkroniserer alle data for den aktuelle dato op til den aktuelle tid
• I går - Synkroniserer alle data for hele den foregående dag
• Sidste 7 dage - Synkroniserer data for de sidste syv dage

Opsummer data

Når du bruger JSON-format med datatypesundhedsmålinger, slå Opsummer data TIL eller FRA.

• TIL - Giver aggregerede dataopsummeringer
• FRA - Giver disaggregerede data, hvor det er muligt, og viser individuelle datapunkter

Bemærk: Denne indstilling gælder kun for JSON-format med sundhedsmålinger. Data aggregeres altid, når du bruger CSV-format, eller når flere målinger er valgt.

Tidsgruppering

Når du bruger JSON-format med Opsummer data aktiveret, skal du vælge, hvordan data skal aggregeres.

Bemærk: CSV-format aggregerer altid data. Aggregering på minut- og sekundniveau kan øge behandlingstiden og datastørrelsen betydeligt.

Batch-forespørgsler og store payloads

Når du bruger JSON-format, slå Batch-forespørgsler TIL for at sende data i flere HTTP-forespørgsler i stedet for én stor payload.

• TIL — Fordeler data over flere forespørgsler. Brug når dit endpoint har payload-grænser, timeouts på store bodies eller du behandler data trinvis.
• FRA — Sender alle data i én forespørgsel. Velegnet til mindre eksporter og simple webhooks.

Hvornår batching aktiveres:

• Mange sundhedsmetrikker valgt, lange datointervaller eller fin tidsgruppering (minutter/sekunder)
• Opsummer data er FRA, og du eksporterer disaggregerede sundhedsmetrikker
• Din server returnerer fejl eller timeouts på store POST-bodies

Bemærkninger:

• Batch-forespørgsler gælder kun for REST API + JSON (ikke CSV).
• Batching reducerer payload-størrelse pr. forespørgsel, men fjerner ikke behovet for at hente data på enheden; langsomme HealthKit-forespørgsler kan stadig vises som advarsler i aktivitetslogge. Se Langsomme forespørgsler i aktivitetslogge.

Synkroniseringskadence

Konfigurer hvor ofte automatiseringen skal uploade data:

Vælg et tal og interval.

Test og verifikation

Verificering af dataformat

Appen inkluderer automatisk disse headere i hver anmodning:

• Content-Type - Indstillet baseret på eksportformat
• automation-name - Navnet på din automatisering
• automation-id - Unik identifikator for automatiseringen
• automation-aggregation - Den valgte tidsgruppering
• automation-period - Det valgte datointerval
• session-id - Unik identifikator for hver anmodning

Fejlfinding

Almindelige problemer

Data modtages ikke ved slutpunkt

• Bekræft, at slutpunkt-URL'en er korrekt
• Tjek, at dit slutpunkt accepterer POST-anmodninger
• Gennemgå autentificeringsheadere
• Tjek slutpunktslogfiler for indgående anmodninger
• Bekræft netværksforbindelse

Tips og bedste praksis

1. Automatisk synkronisering:

   • Oplad din enhed og brug iPhone-spejling
     • Under opladning sætter iOS færre begrænsninger på ydeevnen, så data kan synkroniseres oftere
     • Med iPhone-spejling opfører enheden sig som om den var låst op. Det giver Health Auto Export adgang til sundhedsdata, så automatiserede handlinger kan køre

2. Ydeevne:

   • Brug passende tidsgruppering til at balancere detalje vs. datastørrelse
   • Vælg kun de målinger, du har brug for

3. Pålidelighed:

   • Indstil passende timeout-værdier baseret på dit slutpunkts svartid
   • Overvåg aktivitetslogfiler regelmæssigt

4. Dataformat:

   • Brug JSON til strukturerede data og API'er
   • Brug CSV til simpel dataanalyse eller regnearksintegration
   • Overvej batch-anmodninger til store datasæt eller separat behandling

Visning af aktivitetslogge

1. Tryk på Vis aktivitetslogge på konfigurationsskærmen for automatisering.
2. Gennemgå kørsler (grupperet, nyeste først), og udvid hændelser i hver kørsel.
3. Skelne mellem advarsler (f.eks. langsom sundhedsdataforespørgsel) og fejl (HTTP-fejl, timeouts eller HealthKit-læsefejl)—se Oversigt over automatiseringer — Aktivitetslogge.
4. Vellykkede REST-uploads viser ofte et resumé med format, datatype, eksportperiode og datointerval i kørslen.
5. Del (værktøjslinje) eksporterer den fulde diagnostiske ZIP med App-hændelseslogge til support (samme som Indstillinger → Avanceret).
6. Ryd fjerner kun denne automatisering aktivitetshistorik.