Skip to content

Introduction

Welcome to Pontotel APIs

Pontotel APIs allow you to integrate point management features, scales, holidays and more into your own systems.

Architecture

The Pontotel API follows the principles REST (Representational State Transfer):

  • Resources: Entities like users, employees, scales
  • HTTP Methods: GET, POST, PUT, PATCH, DELETE
  • JSO N: Data format for requests and replies
  • 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

Appeal Description Endpoint
Users System user management /usuarios/
Employees Employee data /empregados/
Employers Business information /empregadores/
Scales Scales and working hours /escalas/
Vacation Holiday management /ferias/
Absences Log of removals /afastamentos/
Workplaces Physical workplaces /locais-trabalho/

Default Response Format

All listing answers follow the format:

JSON
{
  "count": 150,
  "next": "https://apis.pontotel.com.br/pontotel/api/v4/usuarios/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1,
      "username": "usuario1",
      "email": "usuario1@example.com"
    }
  ]
}

HTTP Methods

Method Usage Example
GET List or obtain resources GET /usuarios/
POST Create new resources POST /usuarios/
PUT Update full resource 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 successfully created
204 In 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:

  1. Check prerequisites →
  2. Configure Authentication →
  3. Make first request →