2.1 Setup

Using the Monitoring API requires a number of components:

1. A PDB. This Performance Database is a database with monitoring or performance data. The database in the background can be structured however the supplier of the monitoring system wants. There must, however, be a machine layer that allows for the interpretation of calls made to the system and the retrieval of the appropriate data.
2. A UDB. This User Database is a database with user or personal data. This database is hosted by a different actor, typically a housing cooperation or third party hired by the housing cooperation. The database in the background stores authorization information. The UDB makes the connection between that authorization information and an Authentication Server that generates and validates OAuth2 compliant tokens for accessing information in the PDB. This service can be provided by a third party.
3. An APP that uses the UDB to gain access to data in the PDB and that makes useful information out of that data for specific users.

PDB

An OpenAPI 3.0 compliant API is available through Github and - for those directly wanting to skip to a UI to interact with this API - SwaggerHub (note: the SwaggerHub link changes if the version is updated).

Other than the documentation in this Wiki, no further setup help is provided. If this is required, please ask for setup help through the Issues tab on the Github.

UDB

An OpenAPI 3.0 compliant API is available through Github and - for those directly wanting to skip to a UI to interact with this API - SwaggerHub (note: the SwaggerHub link changes if the version is updated).

Additionally, a simple sample UDB resource server app has been written for testing purposes. This can be found through Github. Its readme.md gives installation instructions. This testing app uses the third party authentication service Auth0, which is free when used sparingly.

APP

There is no sample app provided.