Public
Documentation Settings
Production
Double Column
cURL - cURL
Documentation
Introduction
Authorization
Content
Search
Taxonomy
Triage

Documentation

Getting Started
Our API Platform follows RESTful design patterns. Responses are provided in industry-standard JSON format.

The APIs use the OAuth 2.0 Authorization protocol for authorization. Your account manager will help you set up access to the APIs and obtain a client ID and secret. See the Authorization API for more information.

Use these APIs for working with Healthwise by WebMD Ignite content:

  • Authorization API – Implements the OAuth 2.0 authorization protocol and controls access to our APIs. Your application must retrieve an access token from the Authorization API before that application can use any of our APIs.

  • Content API – Delivers Healthwise by WebMD Ignite content, both articles and topics (structured content). Use the Taxonomy API or the Search API to find specific content.

  • Search API – Supports searches based on keyword and medical codes for articles, topics, and health concepts in the Healthwise by WebMD Ignite consumer taxonomy. Some requests support faceted search responses.

  • Taxonomy API – Provides a taxonomy of consumer focused health concepts that organize the content library. You can use the taxonomy for navigation interfaces and for integrating the Healthwise by WebMD Ignite taxonomy into your applications.

This documentation is intended to list all the calls and capture the parameters for each.

We also offer API documentation by use case.

Authorization

Our APIs and services are secured through the OAuth 2.0 authorization framework. The OAuth framework is a widely adopted standard used to control access to HTTP services. More information on OAuth2.0 can be found here.

Access to any of our APIs requires an access token with the appropriate scopes. An access token is requested from the Authorization API by the supported OAuth flows. The access tokens issued by the Authorization API follow the JSON web token (JWT) standard.

Retrieving a client ID and client secret

A client id and client secret must be provided with each API request.

Contact your account manager to register your application. Your account manager will help with setting up access to our API solution and getting you a client ID and secret. These credentials authorize your application to access our APIs.

  • Keep your client credentials private.

  • Consider these credentials the username and password for your organization to access our APIs.

  • Make sure these credentials are not exposed to individuals outside your organization, including your account manager. For example, do not include your client credentials in a config file that is included as part of a client-side JavaScript application.

POSTRequest Access Token

https://auth.healthwise.net/oauth2/token

Creates an access token from the provided credentials (client id and secret). These tokens are used to grant access to our APIs, and the access token must be provided with each API request.
A client id and client secret must be provided in the request for an access token.

Data Parameters

ParameterTypeDescriptionAllowed Values
grant_typestring[Required] The type of grant allowedclient_credentials
refresh_token
scopestring[Required] A client id has access to one or more scopes which correspond to different Healthwise APIs. If an asterisk (*) is provided in a request for an access token, the access token will authorize access to all scopes for that client id. If one or more scopes are provided in the request, the access token will only be usable for those scopes. Available scopes depend on the client id and what APIs have been authorized for use by your organization.examples: * OR one or more of the following, content.api taxonomy.api search.api authorization.api
productstring[Optional] The space separated list of products that are used to request a list of scopes for that product. If both a scope and a product are requested the union of the scopes will be used.
expires_instring[Optional] Time in seconds the token will be valid. Maximum value: 86400
content_configuration_idstring[Optional] Content Configuration for client
reference_numberstringReference Number
HEADERS
Authorization

Basic {{client_basic}}

Basic token using client ID and client secret seperated by a colon encoded in Base64 format. Example: (clientID:clientSecret)

X-HW-Version

2

Accept

application/json

Bodyurlencoded
grant_type

client_credentials

[Required] Allowed values: client_credentials, refresh_token

scope

*

[Required] Allowed values: * configuration.api consumer.api content.api fulfillment.api link.api packaging.api ccf.api authorization.api

expires_in

[Optional] Time in seconds the token will be valid. Maximum value: 86400

product

[Optional] Space delimited list of products requested

content_configuration_id

[Optional] Content Configuration for client

reference_number

Reference variable

client_token

{{client_token}}

GETGet All Certificates

https://auth.healthwise.net/oauth2/certs

Returns security certificate information allowing validation of JWTs

HEADERS
Content-Type

application/json

The content type of the request

Loading