- The APIs should be used on demand, rather than be queried and pulled into a separate database.
- To leverage the API, the developer must register and use a valid access key.
- The healthfinder.gov logo and URL must be displayed as the content source wherever healthfinder.gov content is used. To properly use the healthfinder.gov API, we ask that the following code is embedded wherever healthfinder.gov content appears on your site.
- The logo and URL only need to appear once on a webpage where healthfinder.gov content appears. Please reference healthfinder.gov as the source and provide credit and the link to healthfinder.gov. The URL does not need to be displayed; wrapping the URL around the healthfinder.gov logo is the proper format.
- Last Updated Date
- Inform visitors of the last time the content was updated.
<LastUpdated>3/1/2014 12:00:00 AM</LastUpdated>
- healthfinder.gov would like to collect basic analytics information on the application and usage data of the healthfinder.gov content.
- The analytics collects: the URL where the content is displayed and how many times the content has been loaded.
- healthfinder.gov content can be presented anywhere on your website.
- Do not manipulate or alter the healthfinder.gov content. This is particularly important for the myhealthfinder API, since the myhealthfinder results are evidence-based and require careful maintenance and oversight by the healthfinder.gov team to ensure they are up to date.
- If the content is mashed up or presented with other content, please ensure that the content provides related value, is consistent with the healthfinder content, and does not harm the integrity of the healthfinder.gov content.
- Use best practices to determine when to use the healthfinder.gov API in real-time versus when to use the API to gather the healthfinder.gov content and store it in a local database.
The following apply to both APIs (Health Topics A to Z and myhealthfinder):
- Required: Include the healthfinder.gov logo and a link to the healthfinder site in each topic and tool presented.
- Required: Embed the analytics code once on each page where a topic or tool is presented.
- Optional: Include the "last updated" date near the healthfinder.gov content.
- To use the API, an account must be created.
- The account’s access key must be passed as part of the query when using the API.