Overview
Notification API supports sending notification to recipients using different communication channels (email, SMS) and different notification channel providers.
Features
- POST/emails endpoint allows to send an email with attachments,
- POST/sms endpoint enables to send a SMS notification.
Notification API uses Microsoft Azure Communication Service as a default service.
Health Check: The GET /healthCheck endpoint allows the API client to check the status of the dependent backend service. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.
Benefits
Notification API enables you to provide the Multi-factor Authentication (MFA) feature for an application.
Multi-factor Authentication (MFA) increases the security of the application by requiring its users to identify themselves by more than a username and password. If the SMS and Email-based One Time Password (OTP)-MFA is enabled, the users are prompted to enter a second factor to verify their identity. An OTP is sent as an SMS and/or email to the user's registered email address and Phone number.
Additionally, Notification API enables sending of the End-of day (EOD) report directly from application to the customer's email. We use API gateway for communication between the applications and email provider.
Security
The Notification API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Notification API is HTTPS.