Introducción¶

Bienvenido a las APIs Pontotel¶

Las APIs Pontotel te permiten integrar funcionalidades de gestión de tiempo, escalas, vacaciones y mucho más en tus propios sistemas.

Arquitectura¶

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

Recursos: Entidades como usuarios, empleados, escalas
Métodos HTTP: GET, POST, PUT, PATCH, DELETE
JSON: Formato de datos para solicitudes y respuestas
Códigos de Estado: Códigos HTTP estándar (200, 201, 400, 404, etc.)
Sin Estado: Cada solicitud es independiente

URL Base¶

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

Recursos Principales¶

Recurso	Descripción	Endpoint
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 ausencias	`/afastamentos/`
Lugares de Trabajo	Ubicaciones físicas de trabajo	`/locais-trabalho/`

Formato de Respuesta Estándar¶

Todas las respuestas de listado siguen este 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"
    }
  ]
}

Métodos HTTP¶

Método	Uso	Ejemplo
GET	Listar u 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/`

Códigos de Estado¶

Código	Significado	Cuándo ocurre
200	OK	Solicitud exitosa
201	Created	Recurso creado exitosamente
204	No Content	Eliminación exitosa
400	Bad Request	Datos inválidos
401	Unauthorized	No autenticado
403	Forbidden	Sin permiso
404	Not Found	Recurso no encontrado
429	Too Many Requests	Límite de tasa excedido
500	Internal Server Error	Error en el servidor

Próximos Pasos¶

Ahora que entiendes la arquitectura básica: