Referencia de API¶

Documentación Interactiva¶

Explore la documentación completa e interactiva de la API Puntotel utilizando nuestra interfaz Swagger UI.

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:

1. Vaya a la sección Authentication
2. Expanda la variable POST /login/
3. Haga clic en "Try it out"
4. Rellene con sus credenciales
5. Haga clic en "Execute"
6. Copie el access_token la respuesta

2. Autorice la interfaz¶

1. Haga clic en el botón "Authorize" la parte superior de la página (ícone de cadeado)
2. En el campo Value, cole el token en formato:

   Text Only
   1	Bearer tu_token_aqui

3. Haga clic en "Authorize"
4. Haga clic en "Close"

3. Prueba variable¶

Ahora puede probar cualquier variable:

1. Navega hasta la variable deseada
2. Haga clic en "Try it out"
3. Rellene los parámetros necesarios
4. Haga clic en "Execute"
5. Vea la respuesta completa a continuación

Navegación rápida por categoría¶

Autenticación¶

• POST /login/ - Realizar sesión y obtener token

Usuarios¶

• GET /usuarios/ - Listar usuarios
• POST /usuarios/ - Crear usuario
• GET /usuarios/{id}/ - Obtener usuario específico
• PUT /usuarios/{id}/ - Actualizar usuario
• DELETE /usuarios/{id}/ - Deletar usuario

Empleados¶

• GET /empregados/ - Listar empleados
• POST /empregados/ - Crear empleado
• GET /empregados/{id}/ - Obtener empleado específico
• PUT /empregados/{id}/ - Actualizar empleado
• DELETE /empregados/{id}/ - Deletar empleado

Empleadores¶

• GET /empregadores/ - Listar empleadores
• POST /empregadores/ - Crear empleador
• GET /empregadores/{id}/ - Obtener empleador específico

Lugares de trabajo¶

• GET /locais-trabalho/ - Listar lugares
• POST /locais-trabalho/ - Crear local

Escalas y Jornadas¶

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

Vacaciones¶

• GET /ferias/ - Listar períodos de vacaciones
• POST /ferias/ - Cadastrar vacaciones

Ausencias¶

• GET /afastamentos/ - Listar alejadas
• POST /afastamentos/ - Registro de expulsión

Descarga de especificación¶

Puede descargar la especificación OpenAPI para uso en otras herramientas:

• Descargar JSON
• Descargar YAML

Herramientas compatibles¶

Importar especificación en:

• Postman - Colecciones y pruebas automatizadas
• Insomnia - Cliente REST
• Swagger Editor - Editor online
• OpenAPI Generator - Generación de SDK
• Stoplight - Diseño y documentación

Versiones API¶

Siguientes pasos¶

• Entender autenticación →
• Explorar entidades →
• Ver ejemplos de código →
• Conocer buenas prácticas →