SCWebCore configuration objects are optional. If you initialize SCWebCore without providing a configuration object, a default configuration will be created for you. This default configuration should setup SCWebCore for (US) English and point it to the current Symptom Checker API demo environment.
The configuration object has the following properties:
public_key
- typically a 3 or 4 letter key for authenticating with the Symptom Checker APIprivate_key
- an 88 character private key for authenticating with the Symptom Checker APIapi_env
- 'demo' or 'api' indicating the Symptom Checker API subdomainapi_version
- '1.2' indicating the major and minor version of the Symptom Checker APIlanguage_code
- String matching a supported language code that will determine what language the SCWebCore members will return content in. This value can be updated at run time by using the Locale setLocale function.age_groups
- An array of the strings 'adult' or 'child'. The age group listed at index 0 will determine the default age group if none is selected on the start screen. If an age group is omitted, requests for resources belonging to that age group will callback with error strings instead of a data.
Licensing
You should make sure that you are configuring for Symptom Checker API utilization within the bounds of your license. Your license may not include the adult content set, in which case you would need to omit the adult option from your configuration. Your license might only be for a single language. Only language_codes for languages you have licensed should be specified in your configuration.
Example Implementation
In the example application we define our configuration within config/all.js
which is a javascript module enumerating our application's build time configuration options. The app property from our build time configuration module will be provided to SCWebCore in the example application. For more information about how SCWebCore is configured in the example application see Instantiating SCWebCore.