Manual do Usuário

Cover - Dados da Capa

Acessando informações da capa do informador

O que são os Dados da Capa?

Os dados da capa fornecem informações essenciais para a exibição da página inicial do informador:

  • Dados do informador: ID, nome completo, primeiros nomes, sobrenome e email
  • Dados do processo: ID, nome e protocolo do processo de provisão (primeiro da lista)
  • Dados do grupo: ID e nome do grupo eclesiástico (primeiro da lista)
  • Textos da capa: Duas linhas de texto adicional baseadas no grupo (primeiro da lista)
  • Lista completa: Campo processes_groups contém todos os processos e grupos que o informador está associado

Textos da Capa por Grupo

Grupo 1

Sem textos

Bispo em saída ou transferido

Não possui textos adicionais na capa.

Grupo 2

Sem textos

Cardeais, Presidência da CNBB e Bispos Eméritos

Não possui textos adicionais na capa.

Grupo 3

Linha 1

Bispos da província, afiliados e Presidente regional

Texto exibido:

SOB SEGREDO PONTIFÍCIO

Grupo 4

Linha 1 e 2

Colégios dos consultores, padres, religiosos e diáconos

Textos exibidos:

SOB SEGREDO PONTIFÍCIO

Sua violação é um pecado grave e punível sob a lei canônica.

Grupo 5

Linha 1 e 2

Leigos engajados

Textos exibidos:

SOB SEGREDO PONTIFÍCIO

Sua violação é um pecado grave e punível sob a lei canônica.

Grupo 6

Linha 1 e 2

Personalidades Civis

Textos exibidos:

SOB SEGREDO PONTIFÍCIO

Sua violação é um pecado grave e punível sob a lei canônica.

Como Usar o Endpoint Cover

1. Fazer Login

Primeiro, faça login na API para obter seu token JWT:

POST /auth/login

2. Chamar o Endpoint Cover

Com seu token JWT, chame o endpoint cover:

GET /cover

Headers:

Authorization: Bearer [seu-token-jwt]

3. Interpretar a Resposta

A resposta conterá todos os dados necessários para exibir a capa:

  • Dados do informador autenticado
  • Dados do processo vinculado ao grupo (primeiro da lista, mantido para compatibilidade)
  • Dados do grupo eclesiástico (primeiro da lista, mantido para compatibilidade)
  • Textos da capa baseados no grupo (primeiro da lista, mantido para compatibilidade)
  • Lista completa: O campo processes_groups contém todos os processos e grupos que o informador está associado, permitindo que informadores em múltiplos processos vejam todas as suas associações

Exemplo de Resposta

{
  "success": true,
  "data": {
    "informer": {
      "id": "uuid-do-usuario",
      "first_name": "João",
      "last_name": "Silva",
      "full_name": "João Silva",
      "email": "joao@example.com"
    },
    "process": {
      "id": "uuid-do-processo",
      "name": "Diocese de Parati-RJ",
      "protocol": "PROV-2025-001"
    },
    "group": {
      "id": "uuid-do-grupo",
      "name": "Grupo 1"
    },
    "cover_texts": {
      "line_1": null,
      "line_2": null
    },
    "processes_groups": [
      {
        "process": {
          "id": "uuid-do-processo",
          "name": "Diocese de Parati-RJ",
          "protocol": "PROV-2025-001"
        },
        "group": {
          "id": "uuid-do-grupo",
          "name": "Grupo 1"
        },
        "cover_texts": {
          "line_1": null,
          "line_2": null
        }
      }
    ]
  }
}

Observações Importantes

Restrições de Acesso

  • Endpoint exclusivo para informadores autenticados
  • Administradores não podem acessar este endpoint
  • Requer autenticação JWT válida

Múltiplos Processos e Grupos

  • Informadores podem estar associados a múltiplos processos e grupos
  • O campo processes_groups retorna todos os processos e grupos do informador
  • Os campos process, group e cover_texts mantêm compatibilidade retornando o primeiro da lista
  • Use o campo processes_groups para exibir todas as associações do informador

Textos Dinâmicos

  • Os textos são definidos por grupo eclesiástico
  • Grupos 1 e 2 não possuem textos adicionais
  • Grupo 3 possui apenas a linha 1
  • Grupos 4, 5 e 6 possuem ambas as linhas
  • As configurações de texto são armazenadas no banco de dados
  • Cada item em processes_groups possui seus próprios textos de capa

Tratamento de Erros

  • 401: Token inválido ou expirado - faça login novamente
  • 403: Acesso negado - usuário não é informador
  • 404: Grupo ou processo não encontrado - contate o administrador