Referência da API¶

Documentação Interativa¶

Explore a documentação completa e interativa da API Pontotel utilizando nossa interface Swagger UI.

Especificação OpenAPI¶

A especificação OpenAPI completa está disponível em:

https://apis.pontotel.com.br/pontotel/api/v4/openapi.json

Interface Interativa¶

Como Usar o Try It Out¶

1. Autentique-se primeiro¶

Antes de testar qualquer endpoint:

1. Vá para a seção Authentication
2. Expanda o endpoint POST /login/
3. Clique em "Try it out"
4. Preencha com suas credenciais
5. Clique em "Execute"
6. Copie o access_token da resposta

2. Autorize a interface¶

1. Clique no botão "Authorize" no topo da página (ícone de cadeado)
2. No campo Value, cole o token no formato:

   Text Only
   1	Bearer seu_token_aqui

3. Clique em "Authorize"
4. Clique em "Close"

3. Teste endpoints¶

Agora você pode testar qualquer endpoint:

1. Navegue até o endpoint desejado
2. Clique em "Try it out"
3. Preencha os parâmetros necessários
4. Clique em "Execute"
5. Veja a resposta completa abaixo

Navegação Rápida por Categoria¶

🔐 Autenticação¶

• POST /login/ - Realizar login e obter token

🏢 Estrutura Organizacional¶

• GET /empregadores/ - Listar empregadores
• POST /empregadores/ - Criar empregador
• GET /locais-trabalho/ - Listar locais
• GET /grupos/ - Listar grupos

👥 Pessoas¶

• GET /usuarios/ - Listar usuários
• POST /usuarios/ - Criar usuário
• GET /empregados/ - Listar empregados
• POST /empregados/ - Criar empregado

📅 Jornada¶

• GET /escalas/ - Listar escalas
• POST /escalas/ - Criar escala
• GET /jornadas/ - Listar jornadas
• GET /marcacoes/ - Listar marcações
• POST /marcacoes/ - Registrar marcação

🏖️ Afastamentos¶

• GET /ferias/ - Listar férias
• POST /ferias/ - Registrar férias
• GET /afastamentos/ - Listar afastamentos
• POST /afastamentos/ - Registrar afastamento
• GET /justificativas/ - Listar justificativas

Download da Especificação¶

Você pode baixar a especificação OpenAPI para uso em outras ferramentas:

• 📥 Download JSON
• 📥 Download YAML

Ferramentas Compatíveis¶

• Postman - Coleções e testes automatizados
• Insomnia - Cliente REST
• Swagger Editor - Editor online
• OpenAPI Generator - Geração de SDKs

Versões da API¶

Próximos Passos¶

• Começar integração →
• Domínios da API →
• Boas Práticas →