Quick Start Guide
This section outlines the steps that should be taken to integrate with the Janus API. The provided steps are the recommended order of implementation when working with the Janus API, and each step contains a link to the main documentation with more detailed information.
1) Test the subscription key using the provided sample JSONs
Alongside this document, MHS provides sample JSONs for the measures being implemented as well as subscription keys to use in development and production environments. The first test to be performed should be confirming the development subscription key works by using the provided “session” JSON sample.
→ See: Common Endpoint Properties
2) Configure the Session request
The first endpoint that must be configured is the Session endpoint, as all other endpoints require a valid sessionID to be created.
→ See: Session Endpoints
3) Formatting items
Assemble an Observation Set to assist with understanding and using the upcoming API requests.
→ See: Item Encoding
4) Set up a thumbprint generator
Thumbprints are a critical part of all Janus Observation and Outcome Sets. A system must be developed to generate and validate Thumbprints for the Data Gatherer, Evaluator, and Enrichment endpoints.
→ See: Thumbprints
5) Configure the Data Gatherer request
The next endpoint in the Janus lifecycle is the Data Gatherer, which collects the observation sets required for the following Evaluate phase.
→ See: Data Gatherer Endpoints
6) Configure webhook to receive Events
Events play a crucial role in understanding when certain actions happen in Janus. They are especially helpful to the Data Gatherer phase, as oftentimes an end user may be free to complete the assessment on their own time. Using a webhook, the calling system can understand when an assessment has been completed and take action.
→ See: Events
7) Configure the Evaluate request
After the Data Gatherer phase, the data collected is ready to be scored. This is done using the required Evaluate phase of the Lifecycle.
→ See: Evaluate Endpoints
8) Configure the Enrichment request (Optional)
An optional step that may be performed after Evaluation is Enrichment, which provides enhanced insights on the assessment results in report formats such as PDF, DOCX, or XLSX.
→ See: Enrichment Endpoints
9) Configure the Enrichment Transformer request (Optional)
Another type of Enrichment is the Enrichment Transformer, which combines data from multiple sessions into a single comparative report.