Introdução

Rotas HTTP do Prime Visita — Server Actions (usadas pela própria UI) não entram aqui, só Route Handlers em src/app/api/**, que existem porque algo fora do Next.js App Router precisa chamá-las (integração externa, webhook, cron, exportação de arquivo, fila offline).

Duas gerações de API

  • API pública v1 (app.primevisita.com.br/v1/...) — pensada pra sistemas externos de terceiros integrarem com os dados de uma empresa. Autenticada por token de acesso (Bearer), com escopo e limite de requisição próprios. Ver API pública v1.
  • Rotas legadas — endpoints mais antigos, cada um com seu próprio esquema de autenticação (sessão, assinatura HMAC, secret de cron, ou nenhuma) — usados internamente pela própria aplicação ou por integrações específicas (webhook do servidor de autenticação, cron externo). Ver Rotas públicas, Webhooks, Rotas autenticadas e Rotas de cron.

Formato

Toda rota (exceto a exportação em .xlsx) responde em JSON. Erros seguem { "error": "mensagem" } com o status HTTP correspondente — ver os exemplos de erro em cada rota.