Introduction
Welcome to Pontotel APIs
The Pontotel APIs allow you to integrate time management, schedules, vacations and much more into your own systems.
Architecture
The Pontotel API follows REST (Representational State Transfer) principles:
- Resources: Entities such as users, employees, schedules
- HTTP Methods: GET, POST, PUT, PATCH, DELETE
- JSON: Data format for requests and responses
- Status Codes: Standard HTTP codes (200, 201, 400, 404, etc.)
- Stateless: Each request is independent
Base URL
| Text Only |
|---|
| https://apis.pontotel.com.br/pontotel/api/v4/
|
Main Resources
| Resource | Description | Endpoint |
| Users | System user management | /usuarios/ |
| Employees | Employee data | /empregados/ |
| Employers | Company information | /empregadores/ |
| Schedules | Work schedules and shifts | /escalas/ |
| Vacations | Vacation management | /ferias/ |
| Absences | Absence records | /afastamentos/ |
| Workplaces | Physical work locations | /locais-trabalho/ |
All listing responses follow this format:
| JSON |
|---|
| {
"count": 150,
"next": "https://apis.pontotel.com.br/pontotel/api/v4/usuarios/?page=2",
"previous": null,
"results": [
{
"id": 1,
"username": "user1",
"email": "user1@example.com"
}
]
}
|
HTTP Methods
| Method | Use | Example |
| GET | List or retrieve resources | GET /usuarios/ |
| POST | Create new resources | POST /usuarios/ |
| PUT | Full resource update | PUT /usuarios/123/ |
| PATCH | Partial update | PATCH /usuarios/123/ |
| DELETE | Remove resources | DELETE /usuarios/123/ |
Status Codes
| Code | Meaning | When it occurs |
| 200 | OK | Successful request |
| 201 | Created | Resource created successfully |
| 204 | No Content | Successful deletion |
| 400 | Bad Request | Invalid data |
| 401 | Unauthorized | Not authenticated |
| 403 | Forbidden | No permission |
| 404 | Not Found | Resource not found |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error |
Next Steps
Now that you understand the basic architecture:
- Check prerequisites →
- Configure authentication →
- Make first request →