Nunciatura Provista

API Documentation V1

Pré-informadores

Usuários criados pelo envio final do G1Q1 (Indicação de informadores) ou pelo cadastro administrativo

Protected (JWT)

Visão geral

Usuários com role pre_informador possuem registro em informers com blacklisted = true por padrão e não podem autenticar na API até serem promovidos/liberados pela administração.

No envio final do questionário G1Q1, para cada linha da lista answers.informers com email ainda inexistente, o sistema cria automaticamente um pré-informador (senha inicial Info123), associa ao processo/grupo da resposta e grava controle de idempotência em g1q1_provisioned_pre_informers.

Endpoints

  • GET /pre-informers — listagem paginada (query: page, per_page, group_id, process_id, diocese_id, category_id, search)
  • GET /pre-informers/{id} — detalhe por users.id ou informers.id
  • POST /pre-informers — criação manual (corpo semelhante ao POST de informadores; role fixa; blacklist ativa; senha padrão se omitida: Info123)
  • PUT /pre-informers/{id} — atualização de dados básicos e do perfil em informers
  • DELETE /pre-informers/{id} — remove o usuário (cascata do relacionamento)
  • PUT /pre-informers/{id}/blacklist — corpo JSON {"blacklisted": true|false}

O payload de resposta segue o mesmo formato de /informers (método formatUserData), incluindo groups_processes quando houver pivot.

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provisao.nabrasil.org.br/v1

ENDPOINT

/pre-informers

Prefixo da API conforme ambiente (ex.: /api/v1/pre-informers).