Introdução¶

Bem-vindo às APIs Pontotel¶

As APIs Pontotel permitem que você integre funcionalidades de gestão de ponto, escalas, férias e muito mais em seus próprios sistemas.

Arquitetura¶

A API Pontotel segue os princípios REST (Representational State Transfer):

Recursos: Entidades como usuários, empregados, escalas
HTTP Methods: GET, POST, PUT, PATCH, DELETE
JSON: Formato de dados para requisições e respostas
Status Codes: Códigos HTTP padrão (200, 201, 400, 404, etc.)
Stateless: Cada requisição é independente

Base URL¶

Text Only
1	`https://apis.pontotel.com.br/pontotel/api/v4/`

Principais Recursos¶

Recurso	Descrição	Endpoint
Usuários	Gestão de usuários do sistema	`/usuarios/`
Empregados	Dados de empregados	`/empregados/`
Empregadores	Informações de empresas	`/empregadores/`
Escalas	Escalas e jornadas de trabalho	`/escalas/`
Férias	Gestão de férias	`/ferias/`
Afastamentos	Registro de afastamentos	`/afastamentos/`
Locais de Trabalho	Locais físicos de trabalho	`/locais-trabalho/`

Formato de Resposta Padrão¶

Todas as respostas de listagem seguem o formato:

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¶

Método	Uso	Exemplo
GET	Listar ou obter recursos	`GET /usuarios/`
POST	Criar novos recursos	`POST /usuarios/`
PUT	Atualizar recurso completo	`PUT /usuarios/123/`
PATCH	Atualização parcial	`PATCH /usuarios/123/`
DELETE	Remover recursos	`DELETE /usuarios/123/`

Status Codes¶

Código	Significado	Quando ocorre
200	OK	Requisição bem-sucedida
201	Created	Recurso criado com sucesso
204	No Content	Deleção bem-sucedida
400	Bad Request	Dados inválidos
401	Unauthorized	Não autenticado
403	Forbidden	Sem permissão
404	Not Found	Recurso não encontrado
429	Too Many Requests	Rate limit excedido
500	Internal Server Error	Erro no servidor

Próximos Passos¶

Agora que você entende a arquitetura básica: