Pular para o conteúdo principal

Catálogo de endpoints

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étodoPathAuthServiço
POST/api/v1/auth/loginpúblicoAuthService.login
POST/api/v1/auth/registerpúblicoAuthService.register
POST/api/v1/auth/send-password-emailpúblicoAuthService.sendPasswordEmail
POST/api/v1/auth/password-reset/requestpúblicoAuthService.requestPasswordReset
POST/api/v1/auth/password-reset/confirmpúblicoAuthService.confirmPasswordReset
GET/api/v1/auth/first-access/token?token=públicoAuthService.decodeFirstAccessToken
POST/api/v1/auth/first-access/confirmpúblico ou BearerconfirmFirstAccessByInviteToken / ByEmailCode / pós-login

Tipo: src/models/types/Auth.ts.


2. Usuários

2.1 CRM Admin e auth — Central

MétodoPathAuthServiço
GET/api/v1/crm-admin/usersBearerUserService (lista admin)
GET/api/v1/auth/users/:userIdBearerdetalhe do autenticado / perfil
PATCH/api/v1/auth/users/:userUuidBearerpatch de perfil auth

2.2 Usuários de empresa — Default

MétodoPathAuthServiço
POST/api/usersBearercriar utilizador (governança)
GET/api/users/:userUuidBearerdetalhe White Label
PUT/api/users/:userUuidBeareratualizar / ativar pendente
POST/api/users/:userUuid/blockBeareralterna bloqueio
GET/api/users/company/:companyUuidBearerusuários da empresa
GET/api/users/company/:companyUuid/subcompaniesBearerusuários das filiais

2.3 Branding de usuário — Default

MétodoPathAuthServiço
GET/PATCH/api/users/me/iconBearerUserBrandingService
GET/PATCH/api/users/me/bannerBeareridem
GET/PATCH/api/users/id/:userUuid/iconBeareridem
GET/PATCH/api/users/id/:userUuid/bannerBeareridem
GET/api/users/branding-jobs/:jobIdBearerpolling 202

Query ?json=true nas leituras de imagem.

2.4 Branding de usuário — Central

MétodoPathAuthServiço
GET/PATCH/api/centralbackend/users/me/iconBearerUserBrandingCentralService
GET/PATCH/api/centralbackend/users/me/bannerBeareridem
GET/PATCH/api/centralbackend/users/id/:userUuid/iconBeareridem
GET/PATCH/api/centralbackend/users/id/:userUuid/bannerBeareridem
GET/api/centralbackend/users/branding-jobs/:jobIdBearerpolling

Usado no perfil (/profile) e avatares Central.


3. Roles

MétodoPathHostAuthServiço
GET/api/centralbackend/rolesCBearerCentralRolesService
GET/api/centralbackend/roles/with-usersCBearerroles + membros (/roles)
GET/api/rolesDBearerCrmRolesService (N0–N5 White Label)
PUT/api/roles/:uuidDBeareratualizar role Default

4. Empresas — Central (/api/v1)

MétodoPathAuthServiço
GET/api/v1/companies?pageNumber=&pageSize=Bearerlistagem “Todas” (painel / diretórios)
GET/api/v1/company/directory/:companyIdBearerdetalhe (endereços, branding, docs)
PATCH/api/v1/company/directory/:companyIdBearer+tenantdados gerais
POST/api/v1/company/directory/:companyId/addressesBearer+tenantcriar endereço
PATCH/api/v1/company/directory/:companyId/addresses/:addressIdBearer+tenantatualizar endereço
PUT/api/v1/company/directory/:companyId/brandingBearer+tenantlogo / cor / metadata
PUT/api/v1/company/directory/:companyId/documentsBearer+tenantmetadados de documentos
GET/api/v1/company/:companyId/userBearerlista/total de usuários
GET/api/v1/company/:companyId/user/with-subcompaniesBearer{ total } no cartão do painel
GET/api/v1/company/:parentCompanyId/tenentid/:tenantId/userBearerusuários do tenant da filial
GET/api/v1/company/:parentCompanyId/tenentid/:tenantIdBearerfiliais ligadas (typo oficial tenentid)
GET/api/v1/company/:parentCompanyId/tenetid/:tenantIdBearerfallback do typo tenetid

5. Empresas — Default (/api/companies, /api/centralcrm)

MétodoPathAuthServiço
POST/api/centralcrm/cadastrocompanyBearercadastro completo de empresa
POST/api/centralcrm/:companyUuid/createuserBearercriar contatos/users da empresa
GET/api/companies?page=Bearerempresas raiz (10/página)
GET/api/companies/search?q=&limit=Bearerbusca (perm-user-list)
GET/api/companies/me/subcompanies-list-contextBearermatriz vs filial
GET/api/companies/:parentCompanyUuid/subcompanies?page=Bearerfiliais
PATCH/api/companies/:companyUuid/blockBearerbloqueia sistema
DELETE/api/companies/:companyUuid/blockBearerdesbloqueia

5.1 Recursos por companyUuid (Default)

Prefixo: /api/companies/:companyUuid.

MétodoSufixoServiço
GET/PATCH/kycCompanyKycService
GET / GET :mccUuid / PATCH/mccsCompanyMccsService
GET/PATCH/adquirentesCompanyAdquirentesService
GET/PATCH/formulasCompanyFormulasService
GET/PATCH/roles-companyCompanyRolesService
GET/PUT/slugCompanySlugService
GET/PATCH/DELETE :itemId/sidebar-painelCompanySidebarPainelService
GET/PATCH/email-templates/:routeCompanyEmailTemplatesService — rotas: first-access, password-reset, proposal, document-delivery, ec-welcome
GET / GET singleton / GET :uuid / PATCH :uuid/taxas-parametrizacao-cartoesCompanyTaxasParametrizacaoCartoesService
GET/POST/PATCH/autentique/configCompanyAutentiqueService
GET/autentique/test-configidem

5.2 MDR rates

MétodoPath
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étodoPath
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étodoPath
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)

6.1 Permissões (metadata-permissions)

MétodoPath
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étodoPathAuthNotas
GET/api/governance/theme-tokenspúblicologin / visitante (Movingpay)
GET/PUT/PATCH/DELETE/api/governance/theme-tokensBearertokens de sistema
GET/PUT/PATCH/DELETE/api/governance/companies/:companyUuid/theme-tokensBearerpor empresa
DELETE/api/governance/companies/:companyUuid/theme-tokens/:tokenKeyBeareruma chave
GET/api/governance/:companyUuid/company-metadata-theme-tokensBearerleitura alternativa

Serviço: GovernanceThemeTokensService.

6.3 Form fields de cadastro (Default-only)

Query típica: companyUuid (e escopo do JWT).

MétodoPath
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étodoPathServiço
GET/api/integration/catalogIntegrationCatalogService
GET/api/integration/catalog/:apiKindidem
GET/api/integration/timezonesIntegrationApiService
GET/api/integration/cep/{cep}via catálogo / presets
GET/api/integration/cnpj/{cnpj}presets
GET/api/integration/bankspresets
POST/api/global-config/http-proxyEndpointHttpProxyService
GET/PATCH/api/global-config/integration-apisGlobalIntegrationApisService
GET/PATCH/api/global-config/masks-filtersGlobalMasksFiltersService
GET/PATCH/api/global-config/masks-overrides/:configuracaoUuididem

7.2 Adquirentes e credenciamentos

MétodoPath
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étodoPath
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étodoPath
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-*

RecursoMétodosPath
KYCGET lista, GET :uuid, POST, PUT :uuid/api/global-kyc
TaxasGET, GET :fieldKey, POST, PUT :fieldKey, DELETE :fieldKey/api/global-taxas
BandeirasGET, GET :uuid, POST, PUT :uuid, DELETE :uuid/api/global-bandeiras
Sidebar painelGET, GET :uuid, POST, PUT :uuid, DELETE :uuid/api/global-sidebar-painel
Plano taxasGET, GET :uuid, POST, PATCH :uuid/api/global-plano-taxas
Plano taxas CETGET, GET :uuid, POST, PATCH :uuid/api/global-plano-taxas-cet
MCC novoGET paginado, GET :id, POST/api/global-mcc-novo
MCC taxasGET paginado, GET :id, POST/api/global-mcc-taxas
CNAE×MCCGET paginado, GET :uuid, POST/api/global-cnae-mcc
Taxas parametrização cartõesGET, GET /singleton, GET :uuid, PATCH :uuid/api/global-taxas-parametrizacao-cartoes

7.6 Fórmulas globais

MétodoPath
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étodoPathAuthServiço
GET/api/tenants/:slug/nomepúblicobranding no login (TenantPublicBrandingService)
GET/api/tenants/id/:tenantId/icon?json=trueBearerTenantIconService
GET/api/tenants/nome/:nome/icon?json=trueBeareridem
PATCH/api/tenants/id/:tenantId/iconBeareridem
PATCH/api/tenants/nome/:nome/iconBearerfallback
GET/api/tenants/id/:tenantId/banner?json=trueBearerTenantBannerService
GET/api/tenants/nome/:nome/banner?json=trueBeareridem
PATCH/api/tenants/id/:tenantId/banner ou nome/:nome/bannerBeareridem
GET/api/tenants/branding-jobs/:jobIdBearerbrandingJobs.ts
GET/api/tenants/id/:tenantId/roles-company/users-overviewBearerTenantRolesOverviewService
GET/api/tenant-storage/meBearerTenantStorageService
GET/api/tenant-storage/tenantsBearer (admin)lista
GET/api/tenant-storage/tenants/:tenantId?detailed=Bearerdetalhe
PATCH/api/tenant-storage/tenants/:tenantId/quota?detailed=Bearerquota
GET/api/analisestecnicasBearer (N0/admin)TechnicalAnalysisService

9. Presença e portal — Central

MétodoPathAuthServiço
GET/api/v1/presence/online-count/main-companiesBearer+tenantPresenceService
GET/api/v1/presence/online-count/sub-companiesBearer+tenantidem
GET/api/v1/presence/online-count/aggregated-by-parent?parentCompanyId=Bearer+tenantidem
GET/api/v1/presence/active-users-globalBearer+tenantfallback do dashboard
GET/api/v1/portal/subdomain-url?portalTenantId=Bearer+tenantTenantSubdomainService

Socket: namespace /presence (Central).


10. Auditoria — Default

MétodoPathAuthServiço
GET/api/logs/company/:companyUuidBearerAuditLogsService — 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étodoPathAuthServiço
GET/PATCH/api/v1/email-templates/:keyBearerSettingsEmailTemplatesService — chaves waving_hand, lock_reset

12. APIs externas (via Central)

MétodoPathAuthServiço
GET/api/v1/external-apis/opencnpj/:cnpjBearerExternalApisService
GET/api/v1/external-apis/cep/v2/:cepBeareridem
GET/api/v1/external-apis/banks/v1Beareridem

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étodoPath 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óduloEstado
/dashboard-lucrosmock profitsDashboardMockData
/geracao-faturasmock invoiceGenerationMockData
/helptickets em i18n (help.mockTickets)
Settings → notificaçõesdemonstração

Índice por pasta de service

PastaPrefixo 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