📊 Retornos e Tratamento de Erros
Esta seção descreve os retornos padrão da API do NotificaES.
✅ 200 — Sucesso
A requisição foi processada com sucesso.
### 📝 Descrição
* A notificação foi aceita
* O processamento é assíncrono
* O ID pode ser utilizado para auditoria futura
---
## ❌ 400 — Bad Request
A requisição possui dados inválidos.
### 📌 Exemplo
```json
{
"errorCode": "string",
"message": "string",
"errorDescription": "O campo 'guidCategoria' é obrigatório"
}
📝 Causa
- Payload incorreto
- Campos obrigatórios ausentes
- Tipos inválidos
⚠️ Nenhuma notificação é processada nesse cenário
🔐 401 — Unauthorized
Falha na autenticação.
📝 Causa
- Token ausente
- Token inválido
- Token expirado
✔ Ação recomendada
- Gerar novo token via Acesso Cidadão
🚫 403 — Forbidden
A requisição está autenticada, porém sem autorização.
📝 Causa
- Sistema não habilitado no NotificaES
- Falta de permissões (scopes)
- Categoria não autorizada
✔ Ação recomendada
- Contatar a equipe SUSEST – Sistemas Estruturantes
💥 500 — Internal Server Error
Erro interno da plataforma.
📌 Exemplo
{
"errorCode": "string",
"message": "string",
"errorDescription": "string"
}
✔ Ação recomendada
- Aguardar alguns instantes e tentar novamente
- Caso persista, acionar a equipe SUSEST
📌 Resumo
| Código | Tipo | Ação |
|---|---|---|
| 200 | Sucesso | Processar resposta |
| 400 | Cliente | Corrigir payload |
| 401 | Auth | Gerar novo token |
| 403 | Permissão | Verificar autorização |
| 500 | Servidor | Retry / suporte |