Introducción¶

Bienvenido a las APIs Pontotel¶

Las APIs Pontotel le permiten integrar funciones de gestión de punto, escalas, vacaciones y mucho más en sus propios sistemas.

Arquitectura¶

La API Pontotel sigue los principios REST (Representational State Transfer):

Recursos: Entidades como usuarios, empleados, escalas
**HTTP Methods**GET, POST, PUT, PATCH, DELETE
JSO N: Formato de datos para consultas y respuestas
Status Codes: Códigos HTTP estándar (200, 201, 400, 404, etc.)
Stateless: Cada solicitud es independiente

Base URL¶

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

Principales recursos¶

Recurso	Descripción	Variable
Usuarios	Gestión de usuarios del sistema	`/usuarios/`
Empleados	Datos de empleados	`/empregados/`
Empleadores	Información de empresas	`/empregadores/`
Escalas	Escalas y jornadas de trabajo	`/escalas/`
Vacaciones	Gestión de vacaciones	`/ferias/`
Ausencias	Registro de alejaciones	`/afastamentos/`
Lugares de trabajo	Lugares físicos de trabajo	`/locais-trabalho/`

Formato de respuesta estándar¶

Todas las respuestas de lista siguen el 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	Ejemplo
GET	Listar o obtener recursos	`GET /usuarios/`
POST	Crear nuevos recursos	`POST /usuarios/`
PUT	Actualizar recurso completo	`PUT /usuarios/123/`
PATCH	Actualización parcial	`PATCH /usuarios/123/`
DELETE	Eliminar recursos	`DELETE /usuarios/123/`

Status Codes¶

Código	Significado	Cuando ocurre
200	Aceptar	Requisición exitosa
201	Created	Recurso creado con éxito
204	No Content	Succión exitosa
400	Bad Request	Datos no válidos
401	Unauthorized	No autenticado
403	Forbidden	Sin permiso
404	Not Found	Recurso no encontrado
429	Too Many Requests	Rate limit excedido
500	Internal Server Error	Error en el servidor

Siguientes pasos¶

Ahora que entiendes la arquitectura básica: