Inventário das rotas HTTP (e sockets) que este frontend chama. Gerado a partir de src/models/services/** e proxies Vite.
Legenda de Host: C = API Central (getApiBaseUrl), D = API Default (getGovernanceApiBaseUrl), A = ABECS MCC (proxy /api/abecs-mcc/{qa|prd}).
Auth: público = sem Bearer; Bearer = JWT da sessão; Bearer+tenant = Bearer e X-Tenant-Id.
1. Autenticação — Central
| Método | Path | Auth | Serviço |
|---|
| POST | /api/v1/auth/login | público | AuthService.login |
| POST | /api/v1/auth/register | público | AuthService.register |
| POST | /api/v1/auth/send-password-email | público | AuthService.sendPasswordEmail |
| POST | /api/v1/auth/password-reset/request | público | AuthService.requestPasswordReset |
| POST | /api/v1/auth/password-reset/confirm | público | AuthService.confirmPasswordReset |
| GET | /api/v1/auth/first-access/token?token= | público | AuthService.decodeFirstAccessToken |
| POST | /api/v1/auth/first-access/confirm | público ou Bearer | confirmFirstAccessByInviteToken / ByEmailCode / pós-login |
Tipo: src/models/types/Auth.ts.
2. Usuários
2.1 CRM Admin e auth — Central
| Método | Path | Auth | Serviço |
|---|
| GET | /api/v1/crm-admin/users | Bearer | UserService (lista admin) |
| GET | /api/v1/auth/users/:userId | Bearer | detalhe do autenticado / perfil |
| PATCH | /api/v1/auth/users/:userUuid | Bearer | patch de perfil auth |
2.2 Usuários de empresa — Default
| Método | Path | Auth | Serviço |
|---|
| POST | /api/users | Bearer | criar utilizador (governança) |
| GET | /api/users/:userUuid | Bearer | detalhe White Label |
| PUT | /api/users/:userUuid | Bearer | atualizar / ativar pendente |
| POST | /api/users/:userUuid/block | Bearer | alterna bloqueio |
| GET | /api/users/company/:companyUuid | Bearer | usuários da empresa |
| GET | /api/users/company/:companyUuid/subcompanies | Bearer | usuários das filiais |
2.3 Branding de usuário — Default
| Método | Path | Auth | Serviço |
|---|
| GET/PATCH | /api/users/me/icon | Bearer | UserBrandingService |
| GET/PATCH | /api/users/me/banner | Bearer | idem |
| GET/PATCH | /api/users/id/:userUuid/icon | Bearer | idem |
| GET/PATCH | /api/users/id/:userUuid/banner | Bearer | idem |
| GET | /api/users/branding-jobs/:jobId | Bearer | polling 202 |
Query ?json=true nas leituras de imagem.
2.4 Branding de usuário — Central
| Método | Path | Auth | Serviço |
|---|
| GET/PATCH | /api/centralbackend/users/me/icon | Bearer | UserBrandingCentralService |
| GET/PATCH | /api/centralbackend/users/me/banner | Bearer | idem |
| GET/PATCH | /api/centralbackend/users/id/:userUuid/icon | Bearer | idem |
| GET/PATCH | /api/centralbackend/users/id/:userUuid/banner | Bearer | idem |
| GET | /api/centralbackend/users/branding-jobs/:jobId | Bearer | polling |
Usado no perfil (/profile) e avatares Central.
3. Roles
| Método | Path | Host | Auth | Serviço |
|---|
| GET | /api/centralbackend/roles | C | Bearer | CentralRolesService |
| GET | /api/centralbackend/roles/with-users | C | Bearer | roles + membros (/roles) |
| GET | /api/roles | D | Bearer | CrmRolesService (N0–N5 White Label) |
| PUT | /api/roles/:uuid | D | Bearer | atualizar role Default |
4. Empresas — Central (/api/v1)
| Método | Path | Auth | Serviço |
|---|
| GET | /api/v1/companies?pageNumber=&pageSize= | Bearer | listagem “Todas” (painel / diretórios) |
| GET | /api/v1/company/directory/:companyId | Bearer | detalhe (endereços, branding, docs) |
| PATCH | /api/v1/company/directory/:companyId | Bearer+tenant | dados gerais |
| POST | /api/v1/company/directory/:companyId/addresses | Bearer+tenant | criar endereço |
| PATCH | /api/v1/company/directory/:companyId/addresses/:addressId | Bearer+tenant | atualizar endereço |
| PUT | /api/v1/company/directory/:companyId/branding | Bearer+tenant | logo / cor / metadata |
| PUT | /api/v1/company/directory/:companyId/documents | Bearer+tenant | metadados de documentos |
| GET | /api/v1/company/:companyId/user | Bearer | lista/total de usuários |
| GET | /api/v1/company/:companyId/user/with-subcompanies | Bearer | { total } no cartão do painel |
| GET | /api/v1/company/:parentCompanyId/tenentid/:tenantId/user | Bearer | usuários do tenant da filial |
| GET | /api/v1/company/:parentCompanyId/tenentid/:tenantId | Bearer | filiais ligadas (typo oficial tenentid) |
| GET | /api/v1/company/:parentCompanyId/tenetid/:tenantId | Bearer | fallback do typo tenetid |
5. Empresas — Default (/api/companies, /api/centralcrm)
| Método | Path | Auth | Serviço |
|---|
| POST | /api/centralcrm/cadastrocompany | Bearer | cadastro completo de empresa |
| POST | /api/centralcrm/:companyUuid/createuser | Bearer | criar contatos/users da empresa |
| GET | /api/companies?page= | Bearer | empresas raiz (10/página) |
| GET | /api/companies/search?q=&limit= | Bearer | busca (perm-user-list) |
| GET | /api/companies/me/subcompanies-list-context | Bearer | matriz vs filial |
| GET | /api/companies/:parentCompanyUuid/subcompanies?page= | Bearer | filiais |
| PATCH | /api/companies/:companyUuid/block | Bearer | bloqueia sistema |
| DELETE | /api/companies/:companyUuid/block | Bearer | desbloqueia |
5.1 Recursos por companyUuid (Default)
Prefixo: /api/companies/:companyUuid.
| Método | Sufixo | Serviço |
|---|
| GET/PATCH | /kyc | CompanyKycService |
GET / GET :mccUuid / PATCH | /mccs | CompanyMccsService |
| GET/PATCH | /adquirentes | CompanyAdquirentesService |
| GET/PATCH | /formulas | CompanyFormulasService |
| GET/PATCH | /roles-company | CompanyRolesService |
| GET/PUT | /slug | CompanySlugService |
GET/PATCH/DELETE :itemId | /sidebar-painel | CompanySidebarPainelService |
| GET/PATCH | /email-templates/:route | CompanyEmailTemplatesService — rotas: first-access, password-reset, proposal, document-delivery, ec-welcome |
GET / GET singleton / GET :uuid / PATCH :uuid | /taxas-parametrizacao-cartoes | CompanyTaxasParametrizacaoCartoesService |
| GET/POST/PATCH | /autentique/config | CompanyAutentiqueService |
| GET | /autentique/test-config | idem |
5.2 MDR rates
| Método | Path |
|---|
| GET | /api/companies/:companyUuid/mdr-rates |
| GET | /api/companies/:companyUuid/mdr-rates/padrao |
| GET | /api/companies/:companyUuid/mdr-rates/mcc/:mcc |
| GET | /api/companies/:companyUuid/mdr-rates/mcc/:mcc/parcelas/:n |
Serviço: CompanyMdrRatesService.
5.3 Taxas MCC
| Método | Path |
|---|
| GET | /api/companies/:companyUuid/taxas-mcc |
| GET | /api/companies/:companyUuid/taxas-mcc/jobs/:jobId |
| GET | /api/companies/:companyUuid/taxas-mcc/buscar?mcc= |
| GET | /api/companies/:companyUuid/taxas-mcc/calcular?mcc= |
| GET | /api/companies/:companyUuid/taxas-mcc/prazos |
| GET/POST | /api/companies/:companyUuid/taxas-mcc/personalizadas |
| GET | /api/companies/:companyUuid/taxas-mcc/cpf/:cpf |
| GET | /api/companies/:companyUuid/taxas-mcc/cnpj/:cnpj |
Serviço: CompanyTaxasMccService.
5.4 Determinação de MCC
| Método | Path |
|---|
| GET | /api/companies/:companyUuid/mcc-determinacao/buscar-cnae?cnae= |
| GET | /api/companies/:companyUuid/mcc-determinacao/cnae/:cnae |
| GET | /api/companies/:companyUuid/mcc-determinacao/cnaes |
| GET | /api/companies/:companyUuid/mcc-determinacao/info |
| GET | /api/companies/:companyUuid/mcc-determinacao/mcc/:mcc/taxas |
| GET | /api/companies/:companyUuid/mcc-determinacao/mcc/:mcc/cnaes-taxas |
Serviço: CompanyMccDeterminacaoService.
6. Governança (Default)
| Método | Path |
|---|
| GET/PATCH | /api/governance/users/:userUuid/metadata-permissions |
| GET/PATCH | /api/governance/users/:userUuid/metadata-permissions/:module |
| GET/PATCH | /api/governance/companies/:companyUuid/metadata-permissions |
| GET/PATCH | /api/governance/companies/:companyUuid/metadata-permissions/:module |
| GET/PATCH | /api/governance/companies/:companyUuid/roles/:roleNumber/metadata-permissions |
| GET/PATCH | /api/governance/companies/:companyUuid/roles/:roleNumber/metadata-permissions/:module |
| PATCH | /api/governance/companies/:companyUuid/roles/:roleNumber/metadata-permissions/:module/options/:option |
Módulos: dashboard, users, white_label, plans, establishments, terminals_local, compliance, documents_manage, rate_simulator, rate_admin, machine_rental, financial_commissions. Serviço: GovernancePermissionsService.
6.2 Theme tokens
| Método | Path | Auth | Notas |
|---|
| GET | /api/governance/theme-tokens | público | login / visitante (Movingpay) |
| GET/PUT/PATCH/DELETE | /api/governance/theme-tokens | Bearer | tokens de sistema |
| GET/PUT/PATCH/DELETE | /api/governance/companies/:companyUuid/theme-tokens | Bearer | por empresa |
| DELETE | /api/governance/companies/:companyUuid/theme-tokens/:tokenKey | Bearer | uma chave |
| GET | /api/governance/:companyUuid/company-metadata-theme-tokens | Bearer | leitura alternativa |
Serviço: GovernanceThemeTokensService.
Query típica: companyUuid (e escopo do JWT).
| Método | Path |
|---|
| GET/PATCH | /api/governance/company-client-form-fields |
| GET/PATCH/DELETE | /api/governance/company-white-label-cadastro-form-fields |
| GET/PATCH/DELETE | /api/governance/company-planos-cadastro-form-fields |
| GET/PATCH/DELETE | /api/governance/company-terminais-cadastro-form-fields |
| GET/PATCH/DELETE | /api/governance/company-estabelecimento-comercial-cadastro-form-fields |
7. Config global e integração (Default)
7.1 Catálogo e proxy
| Método | Path | Serviço |
|---|
| GET | /api/integration/catalog | IntegrationCatalogService |
| GET | /api/integration/catalog/:apiKind | idem |
| GET | /api/integration/timezones | IntegrationApiService |
| GET | /api/integration/cep/{cep} | via catálogo / presets |
| GET | /api/integration/cnpj/{cnpj} | presets |
| GET | /api/integration/banks | presets |
| POST | /api/global-config/http-proxy | EndpointHttpProxyService |
| GET/PATCH | /api/global-config/integration-apis | GlobalIntegrationApisService |
| GET/PATCH | /api/global-config/masks-filters | GlobalMasksFiltersService |
| GET/PATCH | /api/global-config/masks-overrides/:configuracaoUuid | idem |
7.2 Adquirentes e credenciamentos
| Método | Path |
|---|
| GET | /api/global-config/adquirentes_base |
| GET | /api/global-config/adquirentes |
| GET | /api/global-config/adquirentes/search?nome= |
| GET | /api/global-config/adquirentes/:uuid |
| POST | /api/global-config/adquirentes |
| PUT | /api/global-config/adquirentes/:uuid |
| GET | /api/global-config/credenciamentos |
Serviço: GlobalAdquirentesCredenciamentosService.
7.3 MCC globais (config)
| Método | Path |
|---|
| GET | /api/global-config/mccs |
| GET | /api/global-config/mccs/:uuid |
| PATCH | /api/global-config/mccs/:uuid |
7.4 Templates de e-mail globais (Default)
| Método | Path |
|---|
| GET/PATCH | /api/global-config/{welcome-email-template|first-access-email-template|password-reset-email-template|proposal-email-template|document-delivery-email-template} |
| GET/PATCH | /api/global-config/scopes/:scopeUuid/{mesmas rotas} |
Serviço: CompanyEmailTemplatesService.
7.5 CRUD global-*
| Recurso | Métodos | Path |
|---|
| KYC | GET lista, GET :uuid, POST, PUT :uuid | /api/global-kyc |
| Taxas | GET, GET :fieldKey, POST, PUT :fieldKey, DELETE :fieldKey | /api/global-taxas |
| Bandeiras | GET, GET :uuid, POST, PUT :uuid, DELETE :uuid | /api/global-bandeiras |
| Sidebar painel | GET, GET :uuid, POST, PUT :uuid, DELETE :uuid | /api/global-sidebar-painel |
| Plano taxas | GET, GET :uuid, POST, PATCH :uuid | /api/global-plano-taxas |
| Plano taxas CET | GET, GET :uuid, POST, PATCH :uuid | /api/global-plano-taxas-cet |
| MCC novo | GET paginado, GET :id, POST | /api/global-mcc-novo |
| MCC taxas | GET paginado, GET :id, POST | /api/global-mcc-taxas |
| CNAE×MCC | GET paginado, GET :uuid, POST | /api/global-cnae-mcc |
| Taxas parametrização cartões | GET, GET /singleton, GET :uuid, PATCH :uuid | /api/global-taxas-parametrizacao-cartoes |
7.6 Fórmulas globais
| Método | Path |
|---|
| GET/POST | /api/global-formulas |
| GET/PUT/DELETE | /api/global-formulas/:uuid |
| GET/POST | /api/global-formulas/:formulaUuid/variaveis |
| GET/PUT/DELETE | /api/global-formulas/variaveis/:variavelUuid |
Serviço: GlobalFormulasService.
8. Tenants e storage (Default)
| Método | Path | Auth | Serviço |
|---|
| GET | /api/tenants/:slug/nome | público | branding no login (TenantPublicBrandingService) |
| GET | /api/tenants/id/:tenantId/icon?json=true | Bearer | TenantIconService |
| GET | /api/tenants/nome/:nome/icon?json=true | Bearer | idem |
| PATCH | /api/tenants/id/:tenantId/icon | Bearer | idem |
| PATCH | /api/tenants/nome/:nome/icon | Bearer | fallback |
| GET | /api/tenants/id/:tenantId/banner?json=true | Bearer | TenantBannerService |
| GET | /api/tenants/nome/:nome/banner?json=true | Bearer | idem |
| PATCH | /api/tenants/id/:tenantId/banner ou nome/:nome/banner | Bearer | idem |
| GET | /api/tenants/branding-jobs/:jobId | Bearer | brandingJobs.ts |
| GET | /api/tenants/id/:tenantId/roles-company/users-overview | Bearer | TenantRolesOverviewService |
| GET | /api/tenant-storage/me | Bearer | TenantStorageService |
| GET | /api/tenant-storage/tenants | Bearer (admin) | lista |
| GET | /api/tenant-storage/tenants/:tenantId?detailed= | Bearer | detalhe |
| PATCH | /api/tenant-storage/tenants/:tenantId/quota?detailed= | Bearer | quota |
| GET | /api/analisestecnicas | Bearer (N0/admin) | TechnicalAnalysisService |
9. Presença e portal — Central
| Método | Path | Auth | Serviço |
|---|
| GET | /api/v1/presence/online-count/main-companies | Bearer+tenant | PresenceService |
| GET | /api/v1/presence/online-count/sub-companies | Bearer+tenant | idem |
| GET | /api/v1/presence/online-count/aggregated-by-parent?parentCompanyId= | Bearer+tenant | idem |
| GET | /api/v1/presence/active-users-global | Bearer+tenant | fallback do dashboard |
| GET | /api/v1/portal/subdomain-url?portalTenantId= | Bearer+tenant | TenantSubdomainService |
Socket: namespace /presence (Central).
10. Auditoria — Default
| Método | Path | Auth | Serviço |
|---|
| GET | /api/logs/company/:companyUuid | Bearer | AuditLogsService — query: page, limit, userUuid, tenantId, method, path, statusCode, from, to |
Socket: namespace /ws/logs, sala join { companyUuid }, evento new-log.
11. Settings e-mail — Central
| Método | Path | Auth | Serviço |
|---|
| GET/PATCH | /api/v1/email-templates/:key | Bearer | SettingsEmailTemplatesService — chaves waving_hand, lock_reset |
12. APIs externas (via Central)
| Método | Path | Auth | Serviço |
|---|
| GET | /api/v1/external-apis/opencnpj/:cnpj | Bearer | ExternalApisService |
| GET | /api/v1/external-apis/cep/v2/:cep | Bearer | idem |
| GET | /api/v1/external-apis/banks/v1 | Bearer | idem |
13. ABECS MCC (hosts QA/PRD)
Em dev o Vite reescreve /api/abecs-mcc/qa|prd para:
- QA:
https://mcccentralapiqa.azurewebsites.net
- PRD:
https://mcccentralapiprd.azurewebsites.net
Há ainda /api/abecs-mcc-blob?u= para blobs. Serviço: AbecsMccService.
| Método | Path no host ABECS |
|---|
| POST | /api/token/generate |
| POST | /api/token/refresh |
| GET | /api/arquivos-mccs |
| GET | /api/static-cnaes-mccs/cnae/:code |
| GET | /api/static-cnaes-mccs/mcc/:code |
| GET | /api/static-cnpjs-mccs/ativos/cnpj/:digits |
| GET | /api/static-cnpjs-mccs/inativos/cnpj/:digits |
14. Chamadas ad hoc / playground
src/integrationApiDocs/utils/endpointCallUtils.ts e o bloco APIs de governança disparam fetch contra URLs do catálogo (incluindo vendor externo). Não são rotas fixas do CRM; o contrato vive em global_integration_apis + presets em integrationApiVendorPresets.ts.
15. Sem HTTP neste front
| Módulo | Estado |
|---|
/dashboard-lucros | mock profitsDashboardMockData |
/geracao-faturas | mock invoiceGenerationMockData |
/help | tickets em i18n (help.mockTickets) |
| Settings → notificações | demonstração |
Índice por pasta de service
| Pasta | Prefixo típico |
|---|
services/auth | /api/v1/auth |
services/user | /api/v1/crm-admin, /api/v1/auth/users, /api/users, /api/centralbackend/users, /api/v1/presence |
services/roles | /api/centralbackend/roles, /api/roles |
services/company | /api/v1/company*, /api/companies, /api/centralcrm |
services/governance | /api/governance, /api/logs |
services/integration | /api/global-*, /api/global-config, /api/integration, ABECS |
services/tenant | /api/tenants, /api/tenant-storage, /api/v1/portal |
services/technicalAnalysis | /api/analisestecnicas |
services/settings | /api/v1/email-templates |