Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 4.43 KB

README.md

File metadata and controls

57 lines (43 loc) · 4.43 KB
Raw

DCI CRVS API

sequenceDiagram
    autonumber
    actor Integrating client (e.g. G2P)
    Integrating client (e.g. G2P)->>DCI-CRVS-API: Fetch records in DCI-CRVS standard format
    Note over DCI-CRVS-API: Validates DCI-CRVS standards through Zod
    Note over DCI-CRVS-API: Converts Zod objects to OpenCRVS queries
    DCI-CRVS-API->>OpenCRVS: Fetch records in OpenCRVS format
    Note over DCI-CRVS-API: Converts OpenCRVS GraphQL response to DCI-CRVS standard
    DCI-CRVS-API->>Integrating client (e.g. G2P): Responds synchronously or asynchronously<br>in DCI CRVS standards format
Loading

This repository provides DCI standards compliant API for CRVS systems. It communicates between OpenCRVS and any other system that can communicate using the DCI standard.

DCI API standards reference can be found in SPDCI docs.

The package is a Node & TypeScript project and the API is built using Hapi as per OpenCRVS convention.

Prerequisites

  • Existing OpenCRVS installation
  • Node.js (specified in .nvmrc, recommend using nvm)

Local development

Developing locally assumes that you have an running OpenCRVS installation. Integration system client details will be created as a system admin in OpenCRVS web UI. In local development you are able to get a local registrar's token with OpenCRVS DevTool Token generator.

  1. Clone the repository
  2. Run npm install to install dependencies
  3. See OpenCRVS documentation for more details how to create a record search client.
  4. Authenticate your client to get a JWT token to query the API with. This is supplied with Authorization: Bearer <<token>> -header.
  5. Run npm run dev to start the server

Roadmap

dci-crvs-api validates the requests using Zod in http-api/validations and the supported parameters can be figured out using maybeEncryptedSyncSearchRequestSchema and maybeEncryptedAsyncSearchRequestSchema schemas.

Endpoint Description Implementation status
/health Health check endpoint ✅ [email protected]
/oauth2/client/token Get a JWT token with OpenCRVS National System Admin supplied client_id and client_secret ✅ [email protected]
/registry/search Search person(s) in registry using an identifier or custom attributes (async, callback) ✅ [email protected]
/registry/sync/search Search person(s) in registry using an identifier or custom attributes (sync) ✅ [email protected]
/.well-known/jwks.json Exports a JSON Web Key Set containing CRVS public keys ✅ [email protected]
/.well-known/locations.json Contains the location tree of a CRVS using SPDCI Place ✅ [email protected]
/registry/subscribe Notify a social protection system with webhooks about deaths ⏩ Upcoming for [email protected]

Monorepo structure

Package Description
http-api Handles HTTP input & output, payload encryption, validation of JWTs
dci-opencrvs-bridge Converts data from DCI schemas to OpenCRVS search queries and vice versa
opencrvs-api Allows fetching data from OpenCRVS, handles all communication to a CRVS system