Quem deve ler isto: desenvolvedores integrando sistemas internos
(folha, ERP, BI, relógios de ponto customizados) com a Pontua. Você já é
cliente e tem plano com acesso à API.Procurando documentação do produto (manual de uso do dashboard, app mobile)?
Visite ajuda.pontua.com.br.
O que dá pra fazer
Sincronizar quadro de funcionários
Listar colaboradores ativos/inativos, criar e atualizar cadastros, importar
em massa via CSV, exportar para folha.
Consultar e ajustar pontos
Listar batidas e registros de ponto, criar registros via API (relógios
customizados), aprovar ajustes, gerar AFD em conformidade com Portaria 671.
Gerar relatórios sob demanda
AFD, AEJ, espelho de ponto, banco de horas, horas extras, faltas/atrasos,
eventos para folha de pagamento. Polling status + download em JSON/PDF/CSV.
Ler folha de pagamento pronta
Eventos consolidados por colaborador, exportação no layout do seu sistema
de folha (Domínio, Sage, Senior, etc.), confirmação de processado.
Padrão técnico
Protocolo
REST sobre HTTPS. Payloads e respostas em JSON (UTF-8). Datas em ISO 8601 com timezone (2026-04-25T14:30:00-03:00).Autenticação
Token de API enviado no headerAuthorization: Bearer <SEU_TOKEN>.
Tokens são gerados, rotacionados e revogados pelo dashboard em
Configurações → API.Multi-tenant
Cada token é vinculado a uma unidade de negócio específica. Se você atende múltiplos clientes (ex.: contador), gere um token por unidade e gerencie do lado da sua aplicação.Paginação
Padronizada em todas as listagens. Query string?pagina=0&limite=100,
resposta em envelope { pagina, limite, totalRegistros, resultados }.Erros
Envelope JSON{ service, method, message } com HTTP status code semântico.
Mensagens em português, prontas para log.Versionamento
Algumas rotas convivem em duas versões via NestJS versioning. A Referência da API mostra a versão estável recomendada para cada endpoint.Ambientes
| Ambiente | Base URL | Uso |
|---|---|---|
| Produção | https://api.pontua.com.br | Integrações reais |
| Homologação (HML) | https://api.hml.pontua.tech | Testes antes de ir para produção |
| Pré-produção (PRE) | https://api.pre.pontua.tech | Validação de mudanças finais antes de promover para PROD |
[HML] integracao-erp, [PROD] integracao-erp.
Política de estabilidade
- Adições não-quebrantes (novos campos opcionais em response, novos endpoints) podem entrar a qualquer momento — sua integração deve ser tolerante a campos extras e novos valores em enums
- Endpoints marcados como deprecated continuam funcionando hoje; mudanças relevantes são comunicadas por e-mail ao contato técnico da sua conta
Entender e começar
Quick Start
Sua primeira chamada autenticada em 5 minutos
Autenticação
Como gerar, usar, rotacionar e revogar tokens
Erros
Códigos HTTP, envelope de erro, estratégias de retry
Paginação
Como iterar listagens grandes
Multi-tenant
Como o token é vinculado à unidade de negócio
Referência da API
Catálogo completo dos endpoints com try-it interativo
Suporte
- Bug ou comportamento inesperado:
tecnologia@pontua.com.brcomservice,method,messageda resposta + timestamp - Caso de uso não coberto: mesmo endereço — descreva o problema de negócio que está tentando resolver
- Atrasos ou degradação: status.pontua.com.br
- Sugestões de roadmap: seja bem específico, gostamos