APIs Internas

O backend do ERP fornecerá uma API RESTful interna, que será consumida exclusivamente pelo frontend do sistema e por módulos de integração autorizados, como os conectores com a plataforma ZEEV.

Essa API deverá atender aos seguintes critérios:

• 🔹 Padronização e Boas Práticas REST
  A API deverá seguir os princípios REST, incluindo o uso apropriado dos métodos HTTP (GET, POST, PUT, DELETE), códigos de status consistentes (200, 201, 400, 401, 403, 404, 500, etc.) e rotas com nomenclatura clara e semântica. A estrutura de rotas deverá seguir convenções padronizadas como /api/entidade/:id para recursos individuais e /api/entidade para coleções.

• 🔹 Autenticação e Autorização via JWT
  Todas as requisições do frontend ao backend deverão incluir um token JWT válido. O backend será responsável por validar esse token e aplicar as permissões definidas pelo controle de acesso baseado em papéis (RBAC).

• 🔹 Escopo de Acesso Restrito
  A API não será exposta publicamente na internet. O acesso será limitado ao frontend autenticado e a integrações autorizadas sob controle interno da FAEPEN ou da equipe técnica contratada. Chamadas externas não autenticadas deverão ser rejeitadas.

• 🔹 Documentação Técnica da API
  Toda a API deverá ser documentada utilizando Swagger (OpenAPI 3.0) ou equivalente.

Essas diretrizes visam garantir a manutenibilidade, segurança e escalabilidade da interface entre frontend e backend, bem como facilitar futuras integrações internas.