Nunciatura Provista

API Documentation V1

Cover - Dados da Capa

Retorna dados do informador, processo, grupo e textos da capa

Este endpoint é do tipo: Protected

Descrição

Retorna dados necessários para exibição da capa do informador com as seguintes funcionalidades:

  • Retorna dados básicos do informador autenticado (id, nome, email)
  • Retorna informações de todos os processos e grupos vinculados ao informador
  • Retorna lista completa de processos e grupos através do campo processes_groups
  • Mantém compatibilidade com campos process, group e cover_texts (primeiro da lista)
  • Retorna textos da capa baseados no grupo (linha 1 e linha 2) para cada processo/grupo
  • Textos dinâmicos conforme regras de negócio dos grupos eclesiásticos
  • Grupos 1 e 2: sem textos adicionais
  • Grupo 3: apenas linha 1 "SOB SEGREDO PONTIFÍCIO"
  • Grupos 4, 5 e 6: linha 1 e linha 2 completas
  • Acesso exclusivo para informadores autenticados
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/cover

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Accept application/json

Respostas

Sucesso - 200 (Grupos 1 ou 2)

{
  "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
        }
      }
    ]
  }
}

Nota: Informadores dos Grupos 1 e 2 não possuem textos adicionais na capa. O campo processes_groups contém todos os processos e grupos que o informador está associado.

Sucesso - 200 (Grupo 3)

{
  "success": true,
  "data": {
    "informer": {
      "id": "uuid-do-usuario",
      "first_name": "Pedro",
      "last_name": "Santos",
      "full_name": "Pedro Santos",
      "email": "pedro@example.com"
    },
    "process": {
      "id": "uuid-do-processo",
      "name": "Diocese de Parati-RJ",
      "protocol": "PROV-2025-001"
    },
    "group": {
      "id": "uuid-do-grupo",
      "name": "Grupo 3"
    },
    "cover_texts": {
      "line_1": "SOB SEGREDO PONTIFÍCIO",
      "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 3"
        },
        "cover_texts": {
          "line_1": "SOB SEGREDO PONTIFÍCIO",
          "line_2": null
        }
      }
    ]
  }
}

Nota: Informadores do Grupo 3 possuem apenas a linha 1 "SOB SEGREDO PONTIFÍCIO". O campo processes_groups contém todos os processos e grupos que o informador está associado.

Sucesso - 200 (Grupos 4, 5 ou 6)

{
  "success": true,
  "data": {
    "informer": {
      "id": "uuid-do-usuario",
      "first_name": "Maria",
      "last_name": "Costa",
      "full_name": "Maria Costa",
      "email": "maria@example.com"
    },
    "process": {
      "id": "uuid-do-processo",
      "name": "Diocese de Parati-RJ",
      "protocol": "PROV-2025-001"
    },
    "group": {
      "id": "uuid-do-grupo",
      "name": "Grupo 4"
    },
    "cover_texts": {
      "line_1": "SOB SEGREDO PONTIFÍCIO",
      "line_2": "Sua violação é um pecado grave e punível sob a lei canônica."
    },
    "processes_groups": [
      {
        "process": {
          "id": "uuid-do-processo",
          "name": "Diocese de Parati-RJ",
          "protocol": "PROV-2025-001"
        },
        "group": {
          "id": "uuid-do-grupo",
          "name": "Grupo 4"
        },
        "cover_texts": {
          "line_1": "SOB SEGREDO PONTIFÍCIO",
          "line_2": "Sua violação é um pecado grave e punível sob a lei canônica."
        }
      },
      {
        "process": {
          "id": "uuid-do-processo-2",
          "name": "Diocese de São Paulo-SP",
          "protocol": "PROV-2025-002"
        },
        "group": {
          "id": "uuid-do-grupo-2",
          "name": "Grupo 5"
        },
        "cover_texts": {
          "line_1": "SOB SEGREDO PONTIFÍCIO",
          "line_2": "Sua violação é um pecado grave e punível sob a lei canônica."
        }
      }
    ]
  }
}

Nota: Informadores dos Grupos 4, 5 e 6 possuem ambas as linhas de texto completas. O campo processes_groups contém todos os processos e grupos que o informador está associado. Quando o informador está em múltiplos processos, todos serão retornados neste array.

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Usuário não encontrado",
  "errors": []
}

Condição: Token JWT inválido, expirado ou não fornecido

Erro - 403 (Acesso negado)

{
  "success": false,
  "message": "Acesso negado. Este endpoint é exclusivo para informadores.",
  "errors": []
}

Condição: Usuário autenticado não é informador (ex: admin)

Erro - 404 (Grupo não atribuído)

{
  "success": false,
  "message": "Informador não possui grupo atribuído",
  "errors": []
}

Condição: Informador não possui grupo atribuído

Erro - 404 (Processo não vinculado)

{
  "success": false,
  "message": "Grupo não possui processo vinculado",
  "errors": []
}

Condição: Grupo do informador não possui processo vinculado

Códigos de Resposta

Código Descrição
200 Dados da capa retornados com sucesso
401 Token inválido ou expirado
403 Acesso negado (não é informador)
404 Grupo ou processo não encontrado