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

👥 Usuários¶

• GET /usuarios/ - Listar usuários
• POST /usuarios/ - Criar usuário
• GET /usuarios/{id}/ - Obter usuário específico
• PUT /usuarios/{id}/ - Atualizar usuário
• DELETE /usuarios/{id}/ - Deletar usuário

👔 Empregados¶

• GET /empregados/ - Listar empregados
• POST /empregados/ - Criar empregado
• GET /empregados/{id}/ - Obter empregado específico
• PUT /empregados/{id}/ - Atualizar empregado
• DELETE /empregados/{id}/ - Deletar empregado

🏢 Empregadores¶

• GET /empregadores/ - Listar empregadores
• POST /empregadores/ - Criar empregador
• GET /empregadores/{id}/ - Obter empregador específico

📍 Locais de Trabalho¶

• GET /locais-trabalho/ - Listar locais
• POST /locais-trabalho/ - Criar local

📅 Escalas e Jornadas¶

• GET /escalas/ - Listar escalas
• POST /escalas/ - Criar escala

🏖️ Férias¶

• GET /ferias/ - Listar períodos de férias
• POST /ferias/ - Cadastrar férias

🚫 Afastamentos¶

• GET /afastamentos/ - Listar afastamentos
• POST /afastamentos/ - Registrar afastamento

Download da Especificação¶

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

• 📥 Download JSON
• 📥 Download YAML

Ferramentas Compatíveis¶

Importe a especificação em:

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

Versões da API¶

Próximos Passos¶

• Entender autenticação →
• Explorar entidades →
• Ver exemplos de código →
• Conhecer boas práticas →