API externa v1
La API externa tendra el prefijo:
/api/external/v1
La version 1.0.0 documenta 91 operaciones: 14 estables y 77 en estado preview. La referencia agrupa cada endpoint por dominio e identifica las operaciones preview en su descripcion.
Las 74 operaciones administrativas de Configuracion y tres capacidades SAH describen contratos en maduracion. No deben usarse en integraciones productivas hasta completar sus gates individuales.
Artefactos para Postman
Los tres archivos se generan deterministicamente desde la misma fuente versionada y contienen solicitudes y ejemplos sinteticos por operacion.
Probar en Postman
- Descargue e importe la coleccion.
- Importe y seleccione el ambiente
Citas Medicas External API - Template. - Obtenga un token y pegue manualmente su valor en
accessToken, sin agregar el prefijoBearer. - Seleccione una solicitud y reemplace solamente los valores sinteticos indicados.
Nunca comparta el ambiente exportado despues de agregar el token. Las descargas publicas siempre conservan accessToken vacio.
Cobertura por dominio
| Dominio | Operaciones documentadas |
|---|---|
| Pacientes | Resolver identidad, registrar y actualizar paciente |
| Cobertura | Consultar servicios y validar elegibilidad (preview) |
| Agenda | Consultar disponibilidad, listar, reservar, consultar, cancelar y reprogramar citas |
| Gestion complementaria | Lista de espera, preautorizacion (preview) y caso SIAU (preview) |
| Catalogos de Configuracion | 11 recursos con listado, detalle, creacion, actualizacion y eliminacion (preview) |
| Configuracion de agenda | Programas, reglas, relaciones, festivos, bloqueos y generacion de slots (preview) |
Regla de disponibilidad
Una operacion externa se considera publicada solamente cuando dispone de:
- Implementacion y pruebas contractuales.
- Autenticacion de aplicacion y scopes.
- Request, response y errores en OpenAPI.
- Ejemplos sinteticos.
- Guia en este portal.
- Entrada de changelog y politica de compatibilidad.
La seccion Referencia API muestra una pagina por endpoint con autenticacion, headers, parametros, payload, respuestas, errores y ejemplos cURL y JavaScript generados desde OpenAPI.