CuidadoDeSalud.gov para desarrolladores
Estamos haciendo que nuestro código fuente esté disponible gratuitamente en GitHub. Todo nuestro contenido educativo sobre Mercado de Seguros Médicos está disponible en formatos legibles por máquina para que los innovadores, empresarios y socios puedan convertirlo en nuevos productos y servicios.
Código abierto y accesible
Todo el contenido está disponible a través de una API. Todos pueden usar la API para incorporar contenido de CuidadoDeSalud.gov. A medida que se actualice el contenido oficial en CuidadoDeSalud.gov, el nuevo contenido se actualizará automáticamente y aparecerá en los sitios web mediante la API de CuidadoDeSalud.gov.
Desde el primer día, adoptamos los principios de datos abiertos, acceso universal y accesibilidad a través de la simplicidad. Producimos código que cumple con los estándares para que nuestro contenido sea accesible para personas con discapacidades.
API de contenido de CuidadoDeSalud.gov
Nuestro contenido web se publica como páginas HTML y datos JSON. JSON significa Notación de objetos de JavaScript y es un formato de intercambio de datos legible por máquina. Utilice nuestra API JSON para crear aplicaciones y sitios web que compartan el contenido más reciente de CuidadoDeSalud.gov.
Puntos finales de la API
Hay tres tipos de datos disponibles a través de solicitudes
HTTP GET a la API de contenido de CuidadoDeSalud.gov:- Objetos de contenido: el contenido del cuerpo y los metadatos de cada publicación en este sitio web
- Colecciones de contenido: grupos de publicaciones por tipo de contenido, como artículo o término del glosario
- Índice de contenido: un índice de todo el sitio de todas las publicaciones y sus metadatos
Cada punto final devolverá un objeto JSON, una matriz o datos.
Objetos de contenido
Cada publicación de contenido está disponible como objeto JSON. Para acceder a un objeto JSON para una publicación, reemplace la barra inclinada al final de la URL de una publicación con la extensión
.json .Estructura de la solicitud:
https://www.CuidadoDeSalud.gov/:post-title.json Estructura de respuesta:
La API de contenido devuelve objetos que pueden incluir los siguientes atributos:
{ "url": "", "title": "", "content": "", "author": "", "date: "", "lang": "", // Código de idioma: "en " para inglés, "es" para español "categorías": [], // Tipos de contenido y código de idioma "etiquetas": [], // Una variedad de etiquetas de contenido, como "promocionar" "temas": [], // Temas asociados (para artículos) "layout": "", // El diseño utilizado para mostrar el contenido "order": 0, // Posición contextual del contenido } Ejemplo:
https://www.CuidadoDeSalud.gov/accessibility.json Colecciones de contenido
Las colecciones son una lista de objetos de publicación por tipo de contenido. Están disponibles los siguientes tipos de contenido:
articles , blog , questions , glossary , states y topics .Estructura de la solicitud:
https://www.CuidadoDeSalud.gov/api/:content-type.json Estructura de respuesta:
Los recopilados devuelven un objeto JSON con una sola clave y valor. La clave es el tipo de contenido y el valor es una matriz de objetos de publicación, definidos anteriormente.
Ejemplo:
https://www.CuidadoDeSalud.gov/api/glossary.json Índice de contenido
El índice es una lista abreviada de metadatos para todas las publicaciones en este sitio web. Úselo para obtener una vista agregada del contenido y generar consultas adicionales de objetos de publicación.
Estructura de la solicitud:
https://www.CuidadoDeSalud.gov/api/index.json Estructura de respuesta:
La API de índice devuelve una matriz de objetos de resumen para los metadatos de cada publicación.
{ "tags": [], // Una matriz de etiquetas de contenido, como "promover" "categorías": [], // Tipos de contenido y código de idioma "topics": [], // Temas asociados (para artículos ) "title": "", // Título de la publicación "es-title": "" // Traducción al español del título de la publicación, "url": "", // URL de la versión HTML de la publicación (agregar . json for post object) "bite": "", // Un pequeño resumen del post "es-bite": "", // El resumen del post en español "state": [] // Estados asociados al post } Puede haber campos de metadatos adicionales disponibles para categorizar aún más algunas publicaciones.
Ejemplo:
https://www.CuidadoDeSalud.gov/api/index.json Uso de la API de contenido
La mayoría de los marcos web y de aplicaciones incluyen soporte para trabajar directamente con JSON. Por ejemplo, el siguiente código JavaScript utiliza la popular biblioteca JQuery para solicitar una definición de un término del glosario e insertarlo en contenedores en una página web:
$.getJSON('https://www.CuidadoDeSalud.gov/glossary/childrens-health-insurance-program-chip.json', function(d) { $('h1').html(d.título); $('#contenido').html(d.contenido); }); Para obtener más información sobre JSON y recursos en varios lenguajes de programación, consulte la documentación de especificación de JSON..
Solicitudes entre dominios
Para las aplicaciones de JavaScript del lado del cliente, la API de CuidadoDeSalud.gov admite solicitudes entre dominios. La API está habilitada para CORS, lo que significa que autoriza solicitudes de contenido de otros servidores de origen. Con CORS habilitado, las solicitudes de API entre dominios en los navegadores web modernos se realizan de la misma manera que las solicitudes del mismo dominio, como en el ejemplo anterior. Leer más sobre el uso de CORS.
La API también admite solicitudes JSONP. Al agregar un parámetro de
callback de llamada a la solicitud, la API envolverá la respuesta en el valor del parámetro de callback de llamada, por ejemplo:https://www.CuidadoDeSalud.gov/glossary/childrens-health-insurance-program-chip.json?callback=myFunction Esto permite que la solicitud se incruste como un script en lugar de un objeto JSON que debe analizarse. JSONP se considera menos seguro que CORS, pero en algunos casos con un host confiable, es una solución útil. Leer más sobre JSONP.