Nunciatura Provista

API Documentation V1

Acesso por Token (convidado)

Retorna questionário e resposta para preenchimento via token de compartilhamento

Público (token no header ou query)

Descrição

Permite que um convidado externo (sem login) acesse o questionário e a resposta em rascunho usando o token recebido por email. Na primeira vez que o token é usado, o sistema registra o primeiro acesso. O convidado pode editar e salvar rascunho; apenas o responsável pelo processo pode finalizar.

Detalhes do Endpoint

VERBO

GET

URL BASE

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

ENDPOINT

/questionnaires/by-token?token={token}

Token

Enviar o token via query ?token=... ou header X-Questionnaire-Token: ....

Resposta 200

{
  "success": true,
  "data": {
    "questionnaire": { "id": "...", "title": "...", "indicator": "g1q1" },
    "process": { "id": "...", "name": "...", "protocol": "..." },
    "group": { "id": "...", "name": "..." },
    "answer": { "id": "...", "answers": { ... }, "status": "Em andamento" },
    "can_finalize": false
  }
}

401 quando o token não é informado ou é inválido/expirado.

Códigos de Resposta

Código Descrição
200 Dados do questionário e resposta
401 Token não fornecido ou inválido/expirado