Skip to main content

Base URL

https://seudominio.com/api
Em desenvolvimento local:
http://localhost:3000/api

Autenticação

Todas as rotas da API (exceto as públicas) exigem uma sessão autenticada via cookie de sessão NextAuth. Para uso programático (scripts, integrações), faça login via POST /api/auth/callback/credentials e use o cookie de sessão retornado. Veja o guia completo em Autenticação.

Formato

  • Todas as respostas são em JSON
  • Datas seguem o formato ISO 8601 (2026-02-24T20:00:00.000Z)
  • IDs são strings CUID (ex.: cmlz9wf090000sv0yfinj1bja)

Códigos de Status

CódigoSignificado
200Sucesso
201Recurso criado
400Parâmetros inválidos
401Não autenticado
403Sem permissão
404Recurso não encontrado
409Conflito (ex.: e-mail duplicado)
500Erro interno do servidor

Rotas Públicas

Algumas rotas não exigem autenticação:
RotaDescrição
GET /api/test-link/[token]Acesso ao formulário via link único
POST /api/test-link/[token]/submitSubmeter respostas do teste

Especificação OpenAPI

O schema completo da API está disponível em:
  • YAML: docs/openapi.yaml
  • Rota dinâmica: GET /api/openapi?format=json
# Baixar o schema JSON
curl https://seudominio.com/api/openapi?format=json > openapi.json