Referencia de API¶
Documentación Interactiva¶
Explore la documentación completa e interactiva de la API Puntotel utilizando nuestra interfaz Swagger UI.
Acerca de la Documentación Interactiva
La interfaz Swagger UI le permite:
- Visualice todos los endpoints disponibles
- Vea los modelos de datos completos
- Prueba requisiciones directamente (Try it out)
- Copie ejemplos de código
- Explora schemas y validaciones
Especificación OpenAPI¶
La especificación OpenAPI completa está disponible en:
https://apis.pontotel.com.br/pontotel/api/v4/openapi.json
Interfaz¶
Cómo usar Try It Out¶
1. Autentique primero¶
Antes de probar cualquier variable:
- Vaya a la sección Authentication
- Expanda la variable POST /login/
- Haga clic en "Try it out"
- Rellene con sus credenciales
- Haga clic en "Execute"
- Copie el
access_tokenla respuesta
2. Autorice la interfaz¶
- Haga clic en el botón "Authorize" la parte superior de la página (ícone de cadeado)
- En el campo Value, cole el token en formato:
Text Only - Haga clic en "Authorize"
- Haga clic en "Close"
3. Prueba variable¶
Ahora puede probar cualquier variable:
- Navega hasta la variable deseada
- Haga clic en "Try it out"
- Rellene los parámetros necesarios
- Haga clic en "Execute"
- Vea la respuesta completa a continuación
Ambiente de pruebas
Utilice siempre el entorno Sandbox para pruebas vía Swagger UI. Nunca test en producción con datos reales.
Navegación rápida por categoría¶
Autenticación¶
POST /login/- Realizar sesión y obtener token
Estructura organizacional¶
GET /empregadores/- Listar empleadoresPOST /empregadores/- Crear empleadorGET /locais-trabalho/- Listar lugaresGET /grupos/- Listar grupos
Personas¶
GET /usuarios/- Listar usuariosPOST /usuarios/- Crear usuarioGET /empregados/- Listar empleadosPOST /empregados/- Crear empleado
Jornada¶
GET /escalas/- Listar escalasPOST /escalas/- Crear escalaGET /jornadas/- Listar jornadasGET /marcacoes/- Listar marcasPOST /marcacoes/- Registro marcado
Ausencias¶
GET /ferias/- Listar vacacionesPOST /ferias/- Registrar vacacionesGET /afastamentos/- Listar alejadasPOST /afastamentos/- Registro de expulsiónGET /justificativas/- Listar justificaciones
Descarga de especificación¶
Puede descargar la especificación OpenAPI para uso en otras herramientas:
Herramientas compatibles¶
- Postman - Colecciones y pruebas automatizadas
- Insomnia - Cliente REST
- Swagger Editor - Editor online
- OpenAPI Generator - Generación de SDK
Versiones API¶
| Versión | Status | Endpoint Base |
|---|---|---|
| v4 | Atual | https://apis.pontotel.com.br/pontotel/api/v4/ |
| v3 | ⚠️ Deprecated | https://apis.pontotel.com.br/pontotel/api/v3/ |
| v2 | ❌ Sunset | - |