Notificações
Este endpoint gerencia as notificações dos usuários, informando sobre eventos relevantes como novos compartilhamentos ou atualizações importantes.
Objeto Notificação
| Atributo | Tipo | Descrição |
|---|---|---|
id | string | O ID único da notificação (UUID). |
user_id | string | O ID do usuário que recebeu a notificação. |
message | string | O conteúdo da notificação. |
is_read | boolean | Indica se a notificação já foi lida. |
created_at | string | A data e hora em que a notificação foi criada. |
Listar Notificações
Retorna todas as notificações do usuário autenticado.
GET/api/notifications
Resposta
Retorna um array de objetos de Notificação.
Códigos de Status HTTP
200 OK: Notificações listadas com sucesso.401 Unauthorized: Autenticação necessária ou credenciais inválidas.500 Internal Server Error: Erro interno do servidor ao listar as notificações.
Marcar Notificação como Lida
Marca uma notificação específica como lida.
POST/api/notifications/{id}/mark-as-read
Parâmetros de URL
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | string | O ID da notificação a ser marcada como lida. |
Resposta
204 No Content em caso de sucesso.
Códigos de Status HTTP
204 No Content: Notificação marcada como lida com sucesso.401 Unauthorized: Autenticação necessária ou credenciais inválidas.404 Not Found: Notificação não encontrada.500 Internal Server Error: Erro interno do servidor ao marcar a notificação como lida.