Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 2.29 KB

README.md

File metadata and controls

39 lines (24 loc) · 2.29 KB

chs-notification-sender-api

1.0) Introduction

This module receives a request to send a letter or an email via a REST interface and passes that request on to a Kafka 3 queue.

The design for this module and the service it is a part of is here : https://companieshouse.atlassian.net/wiki/spaces/IDV/pages/5146247171/EMail+Service

2.0) Prerequisites

This Microservice has the following dependencies:

OWASP Dependency check

to run a check for dependency security vulnerabilities run the following command:

mvn dependency-check:check

Endpoints

The remainder of this section lists the endpoints that are available in this microservice, and provides links to detailed documentation about these endpoints e.g. required headers, path variables, query params, request bodies, and their behaviour.

Method Path Description Documentation
POST /letter This endpoint can be used to send a letter. LLD - Kafka3 Notification API
POST /email This endpoint can be used to send an email. LLD - Kafka3 Notification API
GET http://127.0.0.1:9000/actuator/health this endpoint is used to check that the service is running