REST API-automatiseringsguide

REST API-automatiseringar gör att du automatiskt kan exportera dina hälsodata till vilken webbtjänst som helst som accepterar HTTP POST-förfrågningar. Detta är idealiskt för att integrera med anpassade backends, tredjeparts-API:er eller webhooks.

Översikt

REST API-automatiseringar skickar dina hälsodata till en angiven URL-endpoint med hjälp av HTTP POST-förfrågningar. Automatiseringen kan skicka data i JSON- eller CSV-format, med konfigurerbara headers för autentisering och anpassade metadata.

Användningsfall:

• Integrering med anpassade backend-tjänster
• Skicka data till webhooks
• Synkronisering med tredjeparts-API:er
• Bygga anpassade dashboards eller analysplattformar

Huvudfunktioner:

• Stöder både JSON- och CSV-format
• Anpassade HTTP-headers för autentisering
• Konfigurerbar förfrågnings-timeout
• Manuell export av historiska data

Begränsningar:

• Åtkomst till hälsodata: Appar får inte komma åt hälsodata när iPhone är låst. Automatiseringar körs bara när enheten är upplåst. Detta är en begränsning från Apple som inte kan kringgås. Mer information

• Bakgrundsbehandling: iOS begränsar bakgrundsbehandling för att spara batteri. Automatiseringar förlitar sig på Bakgrundsuppdatering av app och kanske inte körs direkt om:

  • Bakgrundsuppdatering av app är inaktiverad för appen
  • Enheten är i energisparläge
  • Enheten har varit inaktiv under längre perioder
  • Systemresurser är begränsade
  • Flera appar konkurrerar om bakgrundskörningstid

Prestanda

Tänk på att iOS är optimerat för kortvariga uppgifter på en mobil enhet med mycket snäva prestandabegränsningar. Bakgrundsuppgifter måste vanligtvis slutföras inom 30 sekunder och är begränsade i hur mycket minne de kan använda. Health Auto Export erbjuder stor flexibilitet och anpassningsbarhet, och det kräver att du förstår hur vissa konfigurationer påverkar appens prestanda och resultat.

• Konfiguration: Automatiseringar som producerar stora datamängder kan få systemet att avsluta processen och göra att automatiseringar inte körs i bakgrunden. Följande konfigurationer kan producera stora datamängder:
  • Automatiseringar konfigurerade för att exportera alla hälsomått.
    • Rekommendation: välj bara hälsomått som har sparade data i Apple Health och bara data du faktiskt planerar att använda. Även tomma datatyper påverkar prestandan. Du kan också överväga att dela upp valda hälsomått över flera automatiseringar, vilket gör det lättare för systemet att hantera dem.
  • Automatiseringar med tidsgruppering i sekunder eller minuter, eller med Sammanfatta data avstängt. Sådana detaljerade frågor kan ta lång tid att köra och krocka med systembegränsningar.
    • Rekommendation: även om det kan verka idealiskt att ha så detaljerade data som möjligt, fundera på om den detaljnivån behövs för varje mått eller datatyp. Överväg flera automatiseringar med olika inställningar.
  • Vid export av utomhuspass, som cykling, löpning, vandring m.m. med ruttdata kan GPS och tillhörande hälsomåttsdata producera stora nyttolaster.
• Nyttolaststorlek: Särskilt vid REST API-export: stora nyttolaster kan orsaka serverfel. Se till att din backend är konfigurerad för att hantera nyttolaster på möjligen flera hundra megabyte för att undvika fel.
• Synkroniseringsfrekvens: Lägg till automatiseringar-widgeten på hemskärmen för att hjälpa till att säkerställa att automatiseringar körs framgångsrikt i bakgrunden (se Guide för inställning av automatiseringar-widget).

Förutsättningar

• En giltig URL-endpoint som accepterar HTTP POST-förfrågningar
• Autentiseringsuppgifter (om krävs av din endpoint)
• Nätverksanslutning för att nå din endpoint

Konfiguration

Navigera till skärmen Automatiserade export från huvudnavigeringen, tryck sedan på "Ny automatisering" och välj "REST API" som Automatiserings typ.

Automatiseringsnamn

Ange ett beskrivande namn för din automatisering (t.ex. "Min Backend API", "Webhook-integration").

Notifikationer

Konfigurera när du vill ta emot notifikationer:

• Meddela vid cacheuppdatering - Ta emot en notifikation när cachade data uppdateras
• Meddela vid körning - Ta emot en notifikation varje gång automatiseringen körs

URL-konfiguration

Ange den fullständiga URL:en där du vill skicka dina hälsodata. Detta bör vara en fullständig URL inklusive protokollet (http:// eller https://).

Exempel-URL:er:

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

Obs: URL:en måste vara giltig och tillgänglig från din enhet. Ogiltiga URL:er förhindrar att automatiseringen körs.

Förfrågnings-timeout

Välj ett timeout-intervall för HTTP-förfrågningar. Detta avgör hur länge appen väntar på ett svar innan förfrågan anses ha misslyckats.

HTTP-headers

Lägg till anpassade HTTP-headers för autentisering eller metadata. Vanliga användningsfall inkluderar:

• API-nycklar: X-API-Key: your-api-key
• Auktoriseringstoken: Authorization: Bearer your-token
• Content-type-överskrivningar: Content-Type: application/json

För att lägga till headers:

1. Tryck på "Lägg till headers"
2. Ange header-nyckeln i vänsterfältet
3. Ange header-värdet i högerfältet
4. Upprepa för ytterligare headers

Viktigt: Varje header-nyckel måste ha ett motsvarande värde. Tomma headers ignoreras.

Datatypinställningar

Datatyp

Välj vilken typ av hälsodata som ska exporteras:

• Hälsoindikatorer - Steg, hjärtfrekvens, sömn och andra hälso mätningar
• Träningar - Tränings- och fitnessaktiviteter
• Symptom - Hälsosymptom och tillstånd
• EKG - Elektrokardiogramavläsningar
• Hjärtfrekvensnotifikationer - Hög/låg hjärtfrekvenshändelser
• Sinnestillstånd - Humör- och mentala tillståndsposter (iOS 18.0+)
• Cykelspårning - Menstruationscykel- och reproduktiv hälso data
• Läkemedel - Läkemedelsloggar och följsamhet (iOS 26.0+)

Konfiguration av hälsoindikatorer

När Hälsoindikatorer är valt:

Välj hälsoindikatorer - Välj vilka specifika indikatorer som ska inkluderas. Du kan välja alla tillgängliga indikatorer eller välja specifika.

Tips: Att välja endast de indikatorer du behöver kan förbättra bearbetningstiden och minska datastorleken.

Föredragna källor - Konfigurera vilka datakällor som har prioritet när flera källor tillhandahåller samma indikator.

Träningskonfiguration

När Träningar är valt:

Inkludera rutdata - Växla PÅ för att inkludera rutter för träningar som har platsdata.

Inkludera träningsindikatorer - Växla PÅ för att inkludera hälsoindikatorer som samlas in under träningar (hjärtfrekvens, kalorier, etc.).

Tidsgruppering (träningsindikatorer) - När du använder Exportversion 2 och Inkludera träningsindikatorer är aktiverat:

• Minuter - Grupperar träningsindikatorer per minut
• Sekunder - Grupperar träningsindikatorer per sekund

Exportinställningar

Exportformat

Välj formatet för dina exporterade data:

• JSON-format - Ger detaljerade datastrukturer med kapslade objekt. Bäst för API:er, databaser och applikationer som behöver strukturerade data. JSON-format inkluderar mer detaljerad information för komplexa datatyper som sömnfaser och AFib-avläsningar.

• CSV-format - Ger tabelldata som enkelt kan importeras till kalkylprogram. Bäst för enkel dataanalys eller när din endpoint förväntar sig CSV-data.

Obs: Content-Type-headern sätts automatiskt till application/json för JSON-export och multipart/form-data för CSV-export.

Exportversion

Välj en Exportversion. Versionshantering gör att du kan övergå mellan uppdaterade versioner av exporten i din egen takt och minimerar ändringar som bryter arbetsflöden.

• Version 1 - Äldre format, använd om du har befintliga arbetsflöden som är beroende av detta format
• Version 2 - Aktuellt format med förbättrade träningsdata och mer detaljerade metadataalternativ

Datumintervall

Välj när data ska exporteras:

• Standard - Synkroniserar data för hela föregående dag plus data fram till aktuellt datum och tid
• Sedan senaste synkronisering - Vid varje synkronisering exporteras all data sedan senaste gången exporten kördes fram till aktuellt datum och tid
• Idag - Synkroniserar all data för aktuellt datum fram till aktuell tid
• Igår - Synkroniserar all data för hela föregående dag
• Senaste 7 dagarna - Synkroniserar data för de senaste sju dagarna

Sammanfatta data

När du använder JSON-format med datatyp Hälsoindikatorer, växla Sammanfatta data PÅ eller AV.

• PÅ - Ger aggregerade datasammanfattningar
• AV - Ger desaggregerade data där det är möjligt, visar individuella datapunkter

Obs: Denna inställning gäller endast JSON-format med Hälsoindikatorer. Data aggregeras alltid när du använder CSV-format eller när flera indikatorer är valda.

Tidsgruppering

När du använder JSON-format med Sammanfatta data aktiverat, välj hur data ska aggregeras.

Obs: CSV-format aggregerar alltid data. Aggregering på minut- och sekundnivå kan avsevärt öka bearbetningstiden och datastorleken.

Batchförfrågningar och stora nyttolaster

När du använder JSON-format, slå på Batchförfrågningar för att skicka data i flera HTTP-förfrågningar i stället för en stor nyttolast.

• PÅ — Fördelar data över flera förfrågningar. Använd när din slutpunkt har storleksgränser, tidsgränser på stora bodyn eller bearbetar data stegvis.
• AV — Skickar all data i en förfrågan. Lämpligt för mindre export och enkla webhooks.

När aktivera batch:

• Många hälsomått valda, långa datumintervall eller fin tidsgruppering (minuter/sekunder)
• Sammanfatta data är AV och du exporterar disaggregerade hälsomått
• Servern returnerar fel eller tidsgränser på stora POST-bodyn

Anteckningar:

• Batchförfrågningar gäller endast REST API + JSON (inte CSV).
• Batch minskar nyttolast per förfrågan men tar inte bort hämtning på enheten; långsamma HealthKit-frågor kan fortfarande visas som varningar i aktivitetsloggar. Se Långsamma frågor i aktivitetsloggar.

Synkroniseringsfrekvens

Konfigurera hur ofta automatiseringen ska ladda upp data:

Välj ett nummer och intervall.

Testning och verifiering

Verifiera dataformat

Appen inkluderar automatiskt dessa headers i varje förfrågan:

• Content-Type - Satt baserat på exportformat
• automation-name - Namnet på din automatisering
• automation-id - Unik identifierare för automatiseringen
• automation-aggregation - Den valda tidsgrupperingen
• automation-period - Det valda datumintervallet
• session-id - Unik identifierare för varje förfrågan

Felsökning

Vanliga problem

Data mottas inte vid endpoint

• Verifiera att endpoint-URL:en är korrekt
• Kontrollera att din endpoint accepterar POST-förfrågningar
• Granska autentiseringsheaders
• Kontrollera endpoint-loggar för inkommande förfrågningar
• Verifiera nätverksanslutning

Tips och bästa praxis

1. Automatisk synkronisering:

   • Ladda enheten och använd iPhone-spegling
     • Under laddning sätter iOS färre prestandabegränsningar, så data kan synkroniseras oftare
     • Med iPhone-spegling beter sig enheten som om den vore upplåst. Health Auto Export kan då komma åt hälsodata för automatiserade åtgärder

2. Prestanda:

   • Använd lämplig tidsgruppering för att balansera detalj vs. datastorlek
   • Välj endast de indikatorer du behöver

3. Tillförlitlighet:

   • Sätt lämpliga timeout-värden baserat på din endpoints svarstid
   • Övervaka aktivitetsloggar regelbundet

4. Dataformat:

   • Använd JSON för strukturerade data och API:er
   • Använd CSV för enkel dataanalys eller kalkylprogramintegration
   • Överväg batch-förfrågningar för stora dataset eller separat bearbetning

Visa aktivitetsloggar

1. Tryck på Visa aktivitetsloggar på konfigurationsskärmen för automatisering.
2. Granska körningar (grupperade, nyaste först) och expandera händelser inom varje körning.
3. Skilj på varningar (t.ex. långsam hälsodatafråga) och fel (HTTP-fel, tidsgränser eller HealthKit-läsfel)—se Översikt över automatiseringar — Aktivitetsloggar.
4. Lyckade REST-uppladdningar visar ofta en sammanfattning med format, datatyp, exportperiod och datumintervall i körningen.
5. Dela (verktygsfält) exporterar fullständig diagnostisk ZIP av App-händelseloggar för support (samma som Inställningar → Avancerat).
6. Rensa tar bara bort aktivitetshistoriken för denna automatisering.