Skip to main content
Em 5 minutos você gera um token, faz a primeira chamada autenticada e entende o formato das respostas.

Pré-requisitos

  • Conta Pontua com plano que inclui acesso à API (se não tiver certeza, fale com sua gerência)
  • Permissão de administrador na unidade de negócio (gestão de tokens é restrita)
  • Cliente HTTP da sua escolha — curl, Postman, ou um SDK (Node, Python, Go, etc.)

1. Gere um token de API

1

Acesse o dashboard

Entre em oi.pontua.com.br com sua conta administrativa.
2

Vá para Configurações → API

No menu lateral: Gestão de Pessoas → Configurações → API.
3

Crie um novo token

Clique em Criar novo token. Defina:
  • Nome identificador — descritivo por integração (ex.: [PROD] erp-domínio, [HML] script-relatorio-mensal)
  • Validade — entre 7 dias e 5 anos (ver Autenticação para detalhes)
4

Copie o token IMEDIATAMENTE

O valor aparece uma única vez após gerar. Cole em um cofre de senhas (1Password, Doppler, AWS Secrets Manager) — você não conseguirá vê-lo de novo no dashboard.
Trate o token como senha. Quem o tem lê e modifica dados da unidade de negócio. Não comite em git, não envie por email/Slack, não bote em código frontend.

2. Faça sua primeira chamada

Liste os primeiros 10 colaboradores:
curl --request GET \
  --url 'https://api.pontua.com.br/colaborador?pagina=0&limite=10' \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Accept: application/json'

3. Resposta esperada

{
  "pagina": 0,
  "limite": 10,
  "totalRegistros": 142,
  "resultados": [
    {
      "id": "b9f3d8e0-7f3a-4ec0-9b1e-1234567890ab",
      "nome": "João da Silva",
      "cpf": "12345678900",
      "status": "ATIVO",
      "departamento": {
        "id": "d1e2f3a4-...",
        "nome": "Tecnologia"
      },
      "cargo": {
        "id": "c1a2r3g4-...",
        "nome": "Desenvolvedor Pleno"
      }
    }
    /* ... mais 9 itens ... */
  ]
}
Veja Paginação para iterar todas as páginas e Referência: Colaboradores para o schema completo.

4. Próximos passos

Cadastrar primeiro colaborador via API

Walkthrough completo do POST /colaborador com payload mínimo

Puxar folha do mês

Use /payment-sheet/export para gerar o TXT no layout da sua folha

Entender erros

Códigos HTTP, mensagens comuns, estratégias de retry com backoff

Configurar multi-tenant

Como funciona se você atende múltiplas unidades de negócio

Troubleshooting do primeiro request

SintomaCausa provávelAção
401 Token inválidoToken corrompido ou de ambiente erradoVerifica que Bearer tem espaço, e que o token é o do ambiente que está chamando
401 Token expiradoValidade ultrapassouGera novo token no dashboard, atualiza secret
401 Acesso não autorizadoHeader Authorization ausenteConfirma que está enviando o header (cuidado com proxies que filtram headers)
500 Erro interno em todas as chamadasPossível incidenteCheca status.pontua.com.br
Timeout sem respostaFirewall corporativoAPI está em *.pontua.com.br e *.pontua.tech (HTTPS 443). Libera no firewall
Mais detalhes em Erros.