CuidadoDeSalud.gov para programadores

Estamos haciendo disponible nuestro código fuente gratuitamente en GitHub. Todo nuestro contenido educativo sobre el Mercado de seguros médicos está disponible en lenguaje informático, de tal forma que los innovadores, empresarios, y colaboradores puedan utilizarlo para desarrollar nuevos productos y servicios.

Código abierto y accesible

El código fuente y contenido de CuidadoDeSalud.gov están accesibles en dos formas importantes:

  1. Todo el contenido está disponible a través de un API. Cualquiera puede utilizar el API para integrar contenido de CuidadoDeSalud.gov. Según se actualice el contenido oficial en CuidadoDeSalud.gov, el nuevo contenido quedará actualizado automáticamente y aparecerá en los sitios Web que utilicen el API de HealthCare.gov.

  2. TODO lo que hagamos será publicado en GitHub: Desde actualizaciones de un glosario hasta la actualización de un enlace de un pie de página, estamos haciendo todos nuestros cambios transparentes y disponibles al público.

Desde el primer día, hemos adoptado los principios de código abierto, acceso universal, y accesibilidad a través de simplicidad. Producimos código conforme a los estándares, para hacer nuestro contenido accesible a las personas con discapacidades.

Contenido del API de HealthCare.gov

Nuestro contenido en línea es publicado como páginas HTML en formato JSON. JSON significa JavaScript Object Notation (Notación de objetos en lenguaje JavaScript), y es un formato de intercambio de datos en lenguaje informático. Utilice nuestro API en formato JSON para desarrollar programas y crear sitios Web que incluyan el contenido más actualizado de HealthCare.gov.

Endpoints del API

Existen tres tipos de datos disponibles a través de las solicitudes HTTP GET a CuidadoDeSalud.gov.

Contenido API:

  • Objetos de contenido: el cuerpo del contenido y metadata para cada inserción en este sitio Web
  • Recopilaciones de contenido: grupos de inserciones clasificadas por tipo de contenido, como por ejemplo un artículo, o un término del glosario
  • Índice de contenido: Un índice integral del Sitio de todas las inserciones y su metadata

Cada Endpoint producirá un objeto JSON o matriz, o dato.

Objetos de contenido

Cada inserción de contenido está disponible como un objeto JSON. Para acceder a un objeto JSON y hacer una inserción, cambie la barra oblicua final del URL de una inserción, por la extensión .json.

Estructura de la solicitud:

https://www.healthcare.gov/what-is-the-health-insurance-marketplace.json

Estructura de la respuesta:

  • Atributos para glosario: Fecha, Diseño, Título, Categorías, ID, Lenguaje, URL & Contenido
  • Atributos para artículos y páginas: Fecha, Diseño, Título, Categorías, ID, Lenguaje, URL, Contenido, Etiquetas & Orden
  • Atributos para inserciones en blog: Fecha, Diseño, Título, Categorías, ID, Lenguaje, URL, Autor, Etiquetas, Tópicos & Contenido

Ejemplo:

 https://www.healthcare.gov/api/glossary.json

Recopilaciones de contenido

Las recopilaciones son una lista de objetos insertados clasificados por tipo de contenido. Los siguientes tipos de contenido están disponibles: articles, blog, questions, glossary, states, and topics.

Estructura de la solicitud:

https://www.healthcare.gov/api/:content-type.json

Estructura de la respuesta:

Las recopilaciones facilitan un objeto JSON con una clave y valor únicos. La clave es el tipo de contenido, y el valor es una matriz de objetos insertados, definidos más arriba.

Ejemplo:

 https://www.healthcare.gov/api/glossary.json

Índice de contenido

El índice es una lista abreviada de metadata para todos los insertos en este sitio Web. Utilice el índice para una presentación agregada del contenido y para generar búsquedas adicionales de objetos insertados.

Estructura de la solicitud:

https://www.healthcare.gov/api/index.json

Estructura de la respuesta:

El índice API genera una matriz de objetos resumidos para la metadata de cada inserción.

{
    "tags": [],       // An array of content tags, such as "promote"
    "categories": [], // Content types and language code
    "topics": [],     // Associated topics (for articles)
    "title": "",      // The post's title
    "es-title": ""    // Spanish translation of the post's title,
    "url": "",        // URL to the HTML version of the post (add .json for post object)
    "bite": "",       // A short summary of the post
    "es-bite": "",    // The post summary in Spanish
    "state": []       // Associated states for the post
}

Algunos campos adicionales de metadata pueden estar disponibles para sub-categorizar algunas inserciones.

Ejemplo:

https://www.healthcare.gov/api/index.json

Cómo utilizar contenido API

La mayoría de las estructuras Web y de programas incluyen ayuda para comunicar directamente con JSON. Por ejemplo, el siguiente código JavaScript utiliza el popular catálogo JQuery para solicitar la definición de un término del glosario e insertarla en ciertos campos de una página Web:

$.getJSON('https://www.healthcare.gov/glossary/childrens-health-insurance-program-chip.json', function(d) {
    $('h1').html(d.title);
    $('#content').html(d.content);
});

Para más información acerca de JSON y de recursos en varios lenguajes de programación, por favor consulte la especificación de documentación JSON.

Solicitudes entre dominios

Para programas tipo cliente-servidor JavaScript, el API de HealthCare.gov API permite realizar solicitudes entre dominios. El API permite utilizar CORS, lo que significa que autoriza solicitudes para obtener contenido de otros servidores. Gracias a CORS, las solicitudes API entre dominios a través de navegadores Web modernos, se realiza de la misma forma que las solicitudes dentro de un mismo dominio, como en el ejemplo anterior. Averigüe más acerca de CORS. El API también permite solicitudes JSONP. Añadiendo un parámetro callback a la solicitud, el API adaptará la respuesta al valor del parámetro callback por ejemplo:

https://www.healthcare.gov/glossary/childrens-health-insurance-program-chip.json?callback=myFunction

Esto permite que la solicitud sea insertada como script en vez de un objeto JSON que necesita ser diseccionado. JSONP se considera menos seguro que CORS, pero en algunos con un servidor de confianza, es una solución práctica. Averigüe más acerca de JSONP.

CuidadoDeSalud.gov en GitHub

A view of our GitHub activity leading up to the launch of the new HealthCare.gov.

Nuestra actividad en GitHub en preparación del lanzamiento del nuevo sitio CuidadoDeSalud.gov. * CuidadoDeSalud.gov Source Code * Prose

Otras fuentes de recursos federales para programadores