Desarrolladores

API de ConnectSalud para desarrolladores y agentes

ConnectSalud publica su contenido público como una Content API estática, versionada y autodescriptiva, pensada para desarrolladores y agentes de IA.

Content API de ConnectSalud

La Content API de ConnectSalud expone únicamente contenido ya público: datos de la empresa, preguntas frecuentes, glosario e índice de páginas. Es de solo lectura (solo GET), no requiere autenticación, no contiene datos personales y responde siempre application/json. La versión actual del contrato es v1.0.0 y se sirve bajo /api/v1/.

Endpoints

GET /api/v1/company.json — Datos de la empresa (schema Organization).
GET /api/v1/pages.json — Índice de páginas indexables del sitio.
GET /api/v1/faqs.json — Preguntas frecuentes (lista).
GET /api/v1/glossary.json — Glosario de términos ConnectSalud (lista).
GET /api/v1/glossary/{slug}.json — Un término del glosario por slug.

Cada endpoint tiene un alias sin versión (por ejemplo /api/faqs.json) que sigue la major actual. Las listas usan la forma { object: "list", count, data: [...] }.

Descubrimiento de la API de ConnectSalud

GET /openapi.json — Especificación OpenAPI 3.1.0 de toda la API.
GET /.well-known/api-catalog — Catálogo de enlaces de la API (RFC 9727, application/linkset+json).
GET /api/index.json y GET /api/v1/index.json — Documento de descubrimiento.
GET /api/versions.json — Versiones disponibles.
GET /api/deprecation-policy.json — Política de versionado y deprecación legible por máquina.

Modelo de errores tipado

Los errores 4xx y 5xx devuelven un objeto tipado { error: { code, message, status } } como application/json y, en paralelo, como application/problem+json (RFC 9457). Ambos schemas — Error y Problem — están declarados en /openapi.json, y cada operación documenta sus respuestas 404, 429 y 500.

Versionado y deprecación de la API de ConnectSalud

Los cambios que rompen compatibilidad se publican bajo una nueva major (/api/v2/). Los cambios aditivos se hacen dentro de la major vigente sin aviso. Los endpoints sin versión siguen la major actual. Toda deprecación se señaliza con los encabezados Deprecation (RFC 9745), Sunset (RFC 8594) y Link (rel="deprecation" / rel="successor-version") con un preaviso mínimo de 180 días. La política completa está en https://www.connectsalud.app/api/deprecation-policy.json.

Límite de uso

Las respuestas de la API incluyen los cinco encabezados RateLimit-* y el edge responde 429 con Retry-After cuando se supera el límite. Consulta /openapi.json para el detalle de la política.

llms.txt y CLI

El archivo https://www.connectsalud.app/llms.txt resume el sitio y la API en el formato llmstxt.org. El paquete npm connectsalud ofrece un CLI para consultar la API desde la terminal:

npx connectsalud faqs
npx connectsalud glossary tap
npx connectsalud versions

Sitemap y datos estructurados

El https://www.connectsalud.app/sitemap.xml lista todas las páginas indexables. Cada página incluye JSON-LD de schema.org (Organization, WebSite, WebPage y FAQPage en el Home) y se entrega también como Markdown: añade Accept: text/markdown o pide la ruta con sufijo .md.