Pular para o conteúdo principal

🚀 Endpoints e Funcionalidades

A documentação interativa da API pode ser acessada via Swagger:

👉 PRODUÇÃO https://api.notifica.es.gov.br/swagger

👉 HOMOLOGAÇÃO https://api.notifica.hom.es.gov.br/swagger

Nela você poderá:

  • Visualizar todos os endpoints disponíveis
  • Validar payloads
  • Testar requisições
  • Ver schemas atualizados

📬 Envio de Notificação (Boletim)​

Realiza o envio de notificações para um ou mais destinatários.

🔹 Endpoint​

POST /notificacoes

📥 Payload​

{
  "guidCategoria": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assunto": "Título da notificação",
  "conteudo": "<p>Conteúdo em HTML</p>",
  "destinatariosGuid": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa6" 
  ],
  "meiosEnvio": [1],
  "url": "https://acessocidadao.es.gov.br/meuendpoint-personalizado"
}

📌 Campos​

  • guidCategoria (UUID) GUID Identificador da categoria da notificação.

    ⚠️ Deve estar previamente cadastrada no sistema.

  • assunto (string) Título da notificação exibido no e-mail e no inbox.

  • conteudo (HTML) Conteúdo da mensagem.

    • Não enviar <html> ou <body>
    • Layout já é padronizado pela plataforma
    • Estilização deve ser inline

  • destinatariosGuid (UUID[]) GUID Lista de identificadores dos cidadãos destinatários.

  • meiosEnvio (int[]) Canais de envio:

    ValorCanal
    0Inbox
    1E-mail
    2SMS (não disponível)
    3WhatsApp (não disponível)

  • url (string) Link opcional exibido na notificação. Caso não informado, redireciona para o Acesso Cidadão.

✅ Resposta de Sucesso - 200OK​

{
  "idNotificacao": "00000000-0000-0000-0000-000000000000"
}

✔ Notificação aceita e enfileirada para envio ✔ Já disponível no Inbox do cidadão

⚡ Envio de Notificação Imediata​

Envio direto por e-mail, sem uso de categoria/inbox. ⚠️ Requer autorização especial.

🔹 Endpoint​

POST /notificacoes/uso-interno

📥 Payload​

{
  "assunto": "Título",
  "destinatario": "email@exemplo.com",
  "html": "<html><body><h1>Conteúdo completo</h1></body></html>"
}

📌 Observações​

  • Aqui o HTML deve ser completo
  • O layout é responsabilidade do sistema cliente
  • Deve incluir <html> e <body>

📊 Consulta de Notificações Não Lidas​

Retorna a quantidade de notificações não lidas de um usuário.

🔹 Endpoint​

GET /cidadao/{guid}/notificacoes-nao-lidas

📌 Parâmetro​

  • guid (UUID) Identificador do cidadão

✅ Resposta de Sucesso - 200OK​

{
  "totalNotificacoesNaoLidas": 10
}

🚀 Próximos Passos​

Consulte a seção de Retornos da API para entender todos os cenários de erro e tratamento.