Pular para conteúdo

APIs

O Django REST Framework publica uma API versionada em /api/v1/. Os ViewSets de recursos são ReadOnlyModelViewSet: oferecem listagem e detalhe por GET; escrita nesses recursos retorna método não permitido. A obtenção de token é um endpoint separado.

Autenticação e comportamento comum

  • Token DRF em POST /api/v1/auth/token/; a API também aceita sessão Django.
  • Paginação por página, 20 registros por padrão.
  • SearchFilter e OrderingFilter habilitados globalmente; cada ViewSet define os campos aceitos.
  • Recursos de jobs exigem usuário autenticado e filtram resultados para o próprio usuário.
  • Recursos de dp exigem permissões Django view_<model> concedidas aos grupos do domínio.

Recursos de busca

Recurso Rota Acesso
Sessões de busca /api/v1/jobs/sessoes-busca/ Lista e detalhe das sessões do usuário autenticado.
Vagas /api/v1/jobs/vagas/ Lista e detalhe de vagas vinculadas às sessões do usuário.
Interações /api/v1/jobs/interacoes/ Interações do usuário autenticado.
Consultas de busca /api/v1/jobs/consultas-busca/ Consultas anteriores do usuário autenticado.

Recursos de Departamento Pessoal

Recurso Rota
Cargos e setores /api/v1/dp/cargos/, /api/v1/dp/setores/
Jornadas e feriados /api/v1/dp/jornadas/, /api/v1/dp/feriados/
Funcionários /api/v1/dp/funcionarios/
Marcações e justificativas /api/v1/dp/marcacoes/, /api/v1/dp/justificativas/
Férias e vínculos /api/v1/dp/ferias/, /api/v1/dp/ferias-funcionarios/

Documentação OpenAPI

  • Schema: /api/schema/
  • Swagger UI: /api/docs/
  • Redoc: /api/redoc/

O schema descreve os contratos de leitura e a autenticação configurada. Não há endpoints REST implementados para o domínio Carreira.

Referências

  • Database
  • Governança
  • OpenAPI e serializers: apps/jobs/api/, apps/dp/api/ e config/urls.py no repositório coreflow-people.