Skip to content

MarioFGomes/NotificationAPI

Repository files navigation

Notification API

Notification API é uma aplicação para facilitar o envio de Email e SMS usando os serviços da SendGrid e da Twillo

Instalação e Configuração

Pré-requisitos

  • .NET SDK: Certifique-se de ter o .NET SDK instalado em sua máquina.
  • API Keys: Você precisará das chaves de API da SendGrid e Twilio para autenticar as chamadas.

Instalação

  1. Clone o repositório.
  2. Configure as chaves de API da SendGrid e Twilio no arquivo de configuração.
  3. Instale o PostgreSQL e muda a connectionString no arquivo de configuração
  4. Execute dotnet build para compilar o projeto.

Docker

  1. Instale o Docker Desktop
  2. Clone o repositório
  3. Execute Docker compose up

Uso

NotificationType

Pode salvar os tipos de notificação a ser envidas pela a sua aplicação

Endpoint

POST /api/notificationtype GET /api/notificationtype/getall

Parâmetros de Requisição

  • name: nome do tipo de notificação a ser enviada.
  • description: uma descrição explicando o tipo de notificação

Exemplo de Requisição

{
  "name": "Verification code",
  "description": "when same user ask a verification code"
}