Releases: brighthive/master-client-index
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
Welcome to the Master Client Index 1.0.0!
The Master Client Index (MCI) provides an API for storing, sharing, and managing clients in a Data Trust ecosystem. Clients include all sorts of people, e.g., individuals who completed a program-intake form, students, patients, etc.
API: Core endpoints
v1.0.0 exposes endpoints that:
- GET all users (i.e. clients)
- GET a single user
- POST to create user(s) and, in doing so, generate an associated unique identifier (MCI ID)
- POST to remove PII for a user
API: Helper endpoints
v1.0.0 also exposes endpoints that can GET and POST data related to users, including:
- gender
- address
- disposition
- education_level
- employment_status
- ethnicity
In addition, the health
endpoint provides a way to check the status of the MCI.
Auth
The MCI wraps endpoints in an auth decorator @token_required(Config.get_oauth2_provider())
, which requires the request to include an up-to-date token in the header.
Modularity
The MCI cooperates with two other services: the mci-database
and the mci-matching-service
. The mci-database
contains the data models and migrations for the MCI clients, and the mci-matching-service
contains the logic that calculates a match score for POST'd individuals (who may already exist in the MCI database). This isolation of application concerns allows for customization on a per instance basis.