Skip to content

Contrato — Notificações

Contrato — Notificações

Status: Mock (pendente service de domínio) Termos: Notificação do Aluno, Notificação de Alteração de Conteúdo Controller: notification_api_controller

Endpoint

GET /api/v1/platform/notifications
Authorization: Bearer {wstoken}

Notificações cross-product no bell icon (Header). Diferente de alertas do estudo (/study/{id}/alerts) que são tarefas acionáveis.

Response 200 (shape estável)

{
  "items": [
    {
      "id": 1,
      "type": "content_change|deliverable|reminder|announcement",
      "title": "Conteúdo atualizado",
      "body": "...",
      "read": false,
      "created_at": "2026-04-28T15:00:00Z",
      "action": null
    },
    {
      "id": 2,
      "type": "announcement",
      "title": "Comunicado oficial",
      "body": "...",
      "read": false,
      "created_at": "2026-04-28T16:00:00Z",
      "action": {
        "kind": "open_external",
        "label": "Acessar comunicado",
        "params": { "url": "https://www.helico.com.br/comunicados/abc" }
      }
    }
  ],
  "unread_count": 3
}

action segue o contrato unificado em actions.md. Notificações suportam todos os kind documentados — incluindo open_external (com params.url) para conteúdo fora da Plataforma e open_modal para diálogos in-app.

Erros

HTTP error Causa
401 unauthorized wstoken ausente/inválido

Pendências

  • F6.notification: criar notification_view_service (não existe hoje). Até lá o controller retorna mock — shape acima é o contrato firme.

Referências

  • Source: classes/extensions/platform/controller/notification_api_controller.php
Navigation

Type to search…

↑↓ navigate↵ selectEsc close