Inicio rápido
Esta página te guía a través del trabajo mínimo requerido para incrustar el iframe en tu aplicación, ejecutar un análisis y recuperar el DiagnosticReport resultante. Todo lo descrito aquí se puede personalizar más; consulta la sección Configurar > Personalizar para la referencia de parámetros completa.
1. Obtén un identificador de empresa
El iframe se autentica por medio de un identificador de empresa (también llamado clave de aplicación) que se agrega a la URL del iframe como el parámetro de consulta company.
Generas este identificador desde tu token de API S2S llamando al punto final POST /company-app-keys descrito en la página Seguridad. Cada clave generada tiene un expiresAt explícito, por lo que debes tratar el identificador de empresa como una credencial de corta duración y refrescarlo para cada nueva carga del iframe.
El token de API S2S es el secreto utilizado para acuñar identificadores de empresa. Debe permanecer en tu backend. Solo el valor company resultante de corta duración (el appKey) es seguro para poner en la URL del iframe.
2. Construye la URL del iframe
El iframe se sirve desde https://iframe.legit.health. Agrega los parámetros que necesites; solo company es obligatorio:
<iframe
src="https://iframe.legit.health/?company=YOUR_COMPANY_ID"
width="100%"
height="800"
></iframe>
Usa el generador a continuación para obtener una vista previa de una configuración y copiar la URL resultante. Para la referencia completa de parámetros, consulta la sección Configurar > Personalizar.
El generador utiliza un identificador company de ejemplo para que la vista previa funcione. Reemplázalo con tu propio identificador antes de implementar.
3. Escucha el resultado
Cuando el usuario termina la carga, el iframe publica un mensaje anunciando que el análisis está completo e incluye el identificador del informe resultante:
window.addEventListener("message", function (event) {
if (event.data.message !== "analysis_completed") {
return;
}
const reportId = event.data.id;
// store reportId, fetch the report from your backend, etc.
});
El mismo mensaje se entrega a través de diferentes transportes en iOS y Android. Consulta la página Devoluciones de llamada > Análisis completado para el código por plataforma, y la sección Plataformas para los detalles de incrustación en cada tiempo de ejecución.
4. Recupera el informe
Una vez que tengas un identificador de informe, tu backend obtiene el DiagnosticReport completo de la API:
curl -X GET "https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}?format=raw&locale=en" \
-H "X-API-TOKEN: YOUR_S2S_TOKEN" \
-H "accept: application/json"
La respuesta incluye una URL de descarga de PDF y una URL de informe en vivo que puedes incrustar de vuelta en tu interfaz. Consulta la página Salida > Punto final de API para los parámetros y forma de respuesta, y la sección Esquema JSON de Salida para el esquema de carga completo.
Secuencia de extremo a extremo
El diagrama a continuación muestra el ciclo de vida completo de un único análisis. Los pasos 1, 3, 5 y 6 son los únicos que requieren esfuerzo de integración de tu lado: cargar el iframe, almacenar el reportId del postMessage, y llamar a la API de Legit.Health desde tu backend para recuperar el DiagnosticReport. Todos los demás pasos son manejados por el iframe, el usuario, o la API de Legit.Health.
Pasos siguientes
- ¿Deseas Personalizar el iframe? Consulta la sección Configurar > Personalizar.
- ¿Necesitas Asegurar acceso en producción? Consulta la sección Configurar > Seguridad.
- ¿Deseas Entender la estructura de devoluciones de llamada? Consulta la sección de Devoluciones de llamada.
- ¿Necesitas Mostrar o procesar los resultados? Consulta la sección Salida.