Ir al contenido

Endpoint de API

API Endpoint es un destino de exportación para quienes quieran enviar los datos de Health.md a su propio servidor, webhook, base de datos, panel o automatización. El iPhone sigue leyendo Apple Health; en lugar de escribir archivos, envía mediante POST datos JSON al endpoint que configures.

Recordatorio de privacidad.

Este destino envía deliberadamente los datos de salud seleccionados a la URL que introduzcas. Usa un endpoint que controles o en el que confíes, opta por HTTPS y limita las métricas a las que tu servicio necesite realmente.

  1. Abre Health.md en el iPhone.
  2. Ve a Exportar.
  3. En Destino de exportación, elige API Endpoint.
  4. Introduce una URL como https://api.example.com/healthmd/ingest.
  5. Opcional: introduce un token de portador. Health.md lo almacena en Keychain.
  6. Toca Done, elige el intervalo de fechas y las métricas y, después, toca Export.

Si introduces un token sin prefijo, Health.md lo envía como Authorization: Bearer <token>. Si el valor ya comienza con Bearer o Basic , Health.md lo envía tal como lo introdujiste.

Health.md envía una solicitud POST por cada acción de exportación. El cuerpo es un contenedor healthmd.api_export con una versión independiente que contiene registros diarios healthmd.health_data de esquema público v8. El contenedor de API v1 incluye los registros diarios; v2 también puede incluir datos auxiliares del proveedor sin cambiar el esquema de registro diario.

records

Objetos completos del esquema diario v8 retenidos para el rango solicitado, incluidos los registros completamente vacíos cuyo manifiesto de consulta sirve de evidencia.

failed_date_details

Fechas que fallaron antes de que se pudiera conservar un documento diario.

daily_record_schema_version

La versión del esquema diario dentro de records. Avanza independientemente de la versión del sobre API.

Datos auxiliares del proveedor

Registros externos condicionales de v2, con su propio esquema y sus propias reglas de identidad, cuando hay un proveedor conectado habilitado.

Consulta el contenedor de API v1 completo y el contenedor de API v2 con datos auxiliares del proveedor, ambos generados en producción. El contrato de API y CLI documenta cada campo, límite entre versiones y regla de aceptación.

Método

Aceptar POST.

Tipo de contenido

Aceptar application/json.

Éxito

Devuelve cualquier estado 2xx después de aceptar la carga útil de forma segura.

Errores

Devuelve 4xx o 5xx para las solicitudes rechazadas. Health.md muestra una breve vista previa de la respuesta cuando esté disponible.

Para lograr una ingesta fiable, configura el endpoint para que sea idempotente por fecha. Un usuario puede repetir el mismo rango de exportación después de cambiar las métricas o corregir un error del servidor.

  • Haz una prueba con un solo día antes de cargar un período histórico largo.
  • Mantén habilitados los registros de salud sin pérdidas cuando sea importante conservar íntegramente la fuente; reduce el intervalo de fechas para rutas densas, documentos clínicos, ECG o archivos adjuntos.
  • Valida el token en el servidor antes de almacenar cualquier carga útil.
  • Usa records[].date como clave principal de cada día.
  • Devuelve un cuerpo de error conciso; Health.md solo muestra una breve vista previa.
Problema Suele significar Solución
El objetivo de API no está listo La URL está vacía o no es válida Vuelve a abrir la configuración de API Endpoint e ingrese una URL HTTP(S) válida.
HTTP 401 o 403 Falta el token o se ha rechazado Actualiza las reglas de autenticación del token o del servidor.
HTTP 404 La ruta de la URL es incorrecta Comprueba la ruta en su servidor.
HTTP 413 La carga útil es demasiado grande Exporta menos días; usa una salida solo de resumen únicamente cuando el receptor no necesite registros de origen canónicos.
Faltan algunas fechas No hay datos de HealthKit habilitados para esas fechas Comprueba failed_date_details y su selección de métricas.