Desarrolladores
Integra tus avisos con Salud en Ruta
Envía avisos de médico y enfermería a domicilio desde tu sistema, sigue su estado en tiempo real con webhooks y descarga los informes consentidos. Todo lo necesario para integrarte sin tener que llamarnos.
Lo más consultado
- Primera llamada en 5 minutosCatálogo, alta de un aviso, consulta y primer webhook contra el entorno de pruebas.
- Sandbox y simuladorUn entorno aislado con datos ficticios en el que los avisos avanzan solos.
- WebhooksEventos, cargas de ejemplo y verificación de la firma en cinco lenguajes.
- AutenticaciónClaves de API, ámbitos, rotación y qué hacer si una clave se filtra.
- Pacientes y privacidadQué datos del paciente recibimos, cuáles devolvemos y cuáles nunca.
- Referencia de la APITodos los endpoints, parámetros y esquemas, generados desde openapi.json.
Tu primera llamada
Con una clave de pruebas (srd_test_…), pide el catálogo de tipos de servicio que puedes solicitar:
curl "https://sandbox-api.saludenruta.es/api/integrations/v1/catalog" \
-H "X-Api-Key: $SERAD_API_KEY"- Pruebas (sandbox)
https://sandbox-api.saludenruta.es/api/integrations/v1- Producción
https://api.saludenruta.es/api/integrations/v1
Toda la documentación
Empezar
- Introducción a la API de integración
Qué permite hacer la API de Salud en Ruta, para quién es, cómo es el ciclo de vida de un aviso y qué queda fuera de la integración.
- Primeros pasos
Cómo conseguir acceso a la API y hacer tu primera integración completa en cinco minutos contra el entorno de pruebas: catálogo, alta de un aviso, consulta y primer webhook.
- Entornos de producción y pruebas
Diferencias entre producción y el entorno de pruebas (sandbox), prefijos de las claves, la cabecera X-Serad-Environment, por qué los identificadores cambian entre entornos y la lista de comprobación para pasar a producción.
- Autenticación y seguridad
Cómo autenticar las llamadas con X-Api-Key, qué permite cada ámbito, cómo se rotan y revocan las claves, buenas prácticas y qué hacer si una clave se filtra.
Guías
- Catálogo de servicios
Qué devuelve GET /catalog — tipos de servicio que puedes pedir y profesional que requiere cada uno, aseguradoras finales para intermediarios y si el nº de expediente es obligatorio — y cómo usarlo.
- Avisos
Crear avisos (todos los campos, prioridades, citas, dirección y paciente), consultarlos, listarlos con filtros y paginación, conocer la hora estimada de llegada, cancelarlos y descargar el informe asistencial.
- Pacientes y privacidad
Cómo identificamos a los pacientes, qué datos suyos devolvemos (solo los que tú enviaste) y cuáles no devolvemos nunca, y cómo se tratan los datos de salud y los informes según el RGPD.
- Webhooks
Eventos que te enviamos y cuándo, la carga de cada uno, cómo verificar la firma HMAC-SHA256 en Node.js, Python, PHP, Java y C#, reintentos, deduplicación y cómo probar tu receptor.
- Idempotencia
Cómo usar la cabecera Idempotency-Key para reintentar el alta de un aviso sin crear duplicados, cuánto dura y qué significan los 409.
- Límites de uso
Cuántas peticiones por minuto admite cada clave, las cabeceras X-RateLimit, qué pasa al superar el límite (429 y Retry-After) y cómo reintentar bien.
- Errores
El formato de los errores (RFC 9457), qué significa cada código HTTP y la lista de tipos de error de la API con su causa y su solución.
- Sandbox y simulador
Cómo funciona el entorno de pruebas, el simulador que hace avanzar los avisos, el modo manual con X-Sandbox-Simulation, los endpoints /sandbox/visits/{id}/advance y /sandbox/reset, y los escenarios de prueba recomendados.
Referencia
- Referencia de la API
Todos los endpoints, parámetros, cuerpos, respuestas y esquemas de la API v1, generados a partir de su especificación OpenAPI.
- Ejemplos de código
Ejemplos listos para copiar en curl, JavaScript/TypeScript, Python, PHP, Java y C# para crear, consultar y cancelar avisos y para verificar los webhooks.
Recursos
- Cambios y versiones
Cómo versionamos la API, qué consideramos un cambio compatible, cómo avisamos de los cambios y el registro de cambios desde la v1.
- Preguntas frecuentes
Respuestas rápidas a las dudas más habituales al integrarse con la API de Salud en Ruta.
- Soporte técnico
Cómo contactar con el equipo técnico de Salud en Ruta para dudas de integración, claves y webhooks, incidencias y avisos urgentes.
¿Falta algo o algo no cuadra con lo que ves? Escribe al equipo técnico: info@saludenruta.es.
