Pular para o conteúdo principal

Catálogo de endpoints

Última atualização: 16/09/2026. 191 arquivos em backend/api/**.

Base: {APP_URL}/backend/api + path da tabela. Auth padrão: sessão (cookie). CSRF: header X-CSRF-Token onde a coluna marca sim ou onde o módulo (Tarefas/Comercial) exige em todo POST.

Legenda:

  • Enforced: o PHP chama backend_require_method (outros verbos → 405).
  • Flag: chave canônica quando o código a declara; “módulo / sessão” = auth do domínio sem uma única flag no arquivo fino.
  • Super-admin bypassa flags via backend_permission_user_can().

Contrato: ../api.md. OpenAPI: openapi.yaml. Matriz de autorização (subset): ../permissoes-matriz-endpoints.md.


Core

MétodoPathAuthCSRFFlagDescrição
GET/health.phppúblicanãoDiagnóstico env + ping MySQL (has_db_password, sem vazar senha)

Auth

MétodoPathAuthCSRFFlagDescrição
POST/auth/login.phppública + rate limitnãoLogin bcrypt, popula sessão
POST/auth/forgot-password.phppúblicanãoEnvia e-mail de reset
POST/auth/reset-password.phptokennãoGrava nova senha
GET/POST/auth/logout.phpsessãonãoDestroi sessão
GET/auth/csrf-token.phpsessãoemiteDevolve csrf_token
GET/auth/permissoes.phpsessãonãoRevalida flags + hash SHA-256
GET/auth/white-label-id.phpsessãonãowhite_label_id do operador

Storage

MétodoPathAuthCSRFFlagDescrição
GET/storage/drive-health.phpsessãonãoadmin / storageSaude da service account Drive
GET/storage/ver-arquivo.phpsessãonãosessãoProxy de arquivo (Drive ou disco)

Dashboard

MétodoPathAuthCSRFFlagDescrição
GET/dashboard/bootstrap.phpsessãonãodashboard.*Payload inicial de KPIs/filtros
GET/dashboard/contagem-proposta.phpsessãonãodashboard.*Contagem de propostas
GET/dashboard/estabelecimentos-filtro.phpsessãonãodashboard.*Options de EC no filtro
GET/dashboard/usuarios-filtro.phpsessãonãodashboard.*Options de usuários
GET/dashboard/white-labels-filtro.phpsessãonãodashboard.*Options de WL (super-admin)
GET/dashboard/top10-estabelecimentos-tpv-mes.phpsessãonãodashboard.*Ranking TPV do mês

Usuários

MétodoPathAuthCSRFFlagDescrição
GET/usuarios/listar.phpsessãonãousuarios.ver_todos / escopoLista colaboradores
GET/usuarios/detalhes.phpsessãonãomóduloFicha do usuário
POST/usuarios/salvar.phpsessãorec.usuarios.cadastrarCadastro (serviço de registration)
POST/PUT/usuarios/atualizar.phpsessãorec.usuarios.editarAtualiza cadastro
POST/usuarios/atualizar-status.phpsessãorec.usuarios.aprovar / editarAtivo / bloqueado / pendente
POST/usuarios/excluir.phpsessãorec.usuarios.excluirExclusão
POST/usuarios/validar-cadastro.phpsessãorec.móduloValidação pré-save (CPF/e-mail)
GET/POST/usuarios/taxas.phpsessãorec.taxas usuárioCusto efetivo do colaborador
GET/POST/usuarios/taxas-mdr.phpsessãorec.taxas usuárioMDR do colaborador
GET/usuarios/taxas-padrao.phpsessãonãomóduloDefaults para herança

Permissões

MétodoPathAuthCSRFFlagDescrição
GET/permissoes/usuarios.phpsessãonãopermissoes.* / admin.permissoesLista usuários p/ gestão
GET/permissoes/buscar.phpsessãonãoidem + Política BCatálogo + flags do alvo
POST/permissoes/salvar.phpsessãosimidemPersiste permissao_usuario
GET/permissoes/listar-usuario.phpsessãonãoidemFlags de um user_id
GET/permissoes/buscar-escopo-white-label.phpsessãonãoWL escopowhite_label_permissao
POST/permissoes/salvar-escopo-white-label.phpsessãosimWL escopoGrava delegação do tenant
GET/permissoes/verificar-colaboradores.phpsessãonãomóduloGate de tela colaboradores
GET/permissoes/verificar-estabelecimentos.phpsessãonãomóduloGate de tela EC
GET/permissoes/verificar-terminais.phpsessãonãomóduloGate de tela terminais

White Label

MétodoPathAuthCSRFFlagDescrição
GET/white-label/listar.phpsessãonãowhite_label.*Lista tenants
GET/white-label/listar-ativos.phpsessãonãomóduloSó ativos (selects)
GET/white-label/listar-select.phpsessãonãomóduloOptions compactas
GET/white-label/buscar.phpsessãonãomóduloFicha
POST/white-label/salvar.phpsessãorec.white_label.cadastrarCria tenant + herança de taxas
POST/white-label/atualizar.phpsessãorec.white_label.editarAtualiza cadastro/branding
POST/white-label/alterar-status.phpsessãosimwhite_label.editarAtiva / inativa
POST/white-label/excluir.phpsessãosimwhite_label.excluirExclui
GET/POST/white-label/taxas.phpsessãorec.white_label.gerenciar_taxasTaxas custo efetivo
GET/POST/white-label/gestao-taxas.phpsessãorec.idemTela de gestão / MDR
GET/white-label/buscar-cnpj.phpsessãonãocadastrarLookup CNPJ
GET/white-label/buscar-cep.phpsessãonãocadastrarViaCEP
GET/white-label/buscar-bancos.phpsessãonãocadastrarCOMPE
POST/white-label/corrigir-logotipos.phpsessãorec.editarRepara paths de logo

Planos

MétodoPathAuthCSRFFlagDescrição
GET/planos/listar-locais.phpsessãonãoplanos.*Planos no banco local
GET/planos/listar-remotos.phpsessãonãomóduloPlanos na Movingpay
GET/planos/listar-select.phpsessãonãomóduloOptions p/ vínculo EC
GET/planos/buscar-planos.phpsessãonãomóduloBusca
GET/planos/detalhes.phpsessãonãomóduloFicha
GET/planos/detalhes-cet.phpsessãonãomóduloCET detalhado
GET/planos/plano-edicao.phpsessãonãoeditarPayload do popup de edição
POST/planos/processar-cadastro.phpsessãorec.planos.cadastrarCria plano + taxas
POST/planos/processar-edicao-popup.phpsessãorec.planos.editarAtualiza via popup
POST/planos/processar-exclusao.phpsessãorec.planos.excluirExclui se sem vínculo
GET/planos/taxas-debito.phpsessãonãomóduloTabela débito

Gestão de taxas

MétodoPathAuthCSRFFlagDescrição
GET/gestao-taxas/listar_usuarios.phpsessãonãotaxasUsuários p/ override
GET/gestao-taxas/listar_bandeiras.phpsessãonãotaxasCatálogo de bandeiras
GET/gestao-taxas/listar_taxas.phpsessãonãotaxasGrid de taxas
GET/gestao-taxas/padrao.phpsessãonãotaxasTabela padrão do sistema
POST/gestao-taxas/criar_taxa.phpsessãorec.taxasCria linha
POST/gestao-taxas/atualizar_taxa.phpsessãorec.taxasAtualiza (incl. cash-in)
POST/gestao-taxas/salvar_taxa_mdr.phpsessãorec.taxasPersiste MDR

Estabelecimentos

MétodoPathAuthCSRFFlagDescrição
GET/estabelecimentos/listar-locais.phpsessãonãoestabelecimentos.*Carteira local
GET/estabelecimentos/listar-remotos.phpsessãonãomóduloCarteira na adquirente
GET/estabelecimentos/detalhes.phpsessãonãomóduloModal de detalhes
POST/estabelecimentos/processar-cadastro.phpsessãorec.cadastrarFluxo padrão
POST/estabelecimentos/processar-cadastro-mdr.phpsessãorec.cadastrarFluxo MDR + Movingpay
POST/estabelecimentos/atualizar-local.phpsessãorec.editarPatch local (+ sync remoto)
POST/estabelecimentos/atualizar-remoto.phpsessãorec.editarPatch na adquirente
POST/estabelecimentos/excluir.phpsessãorec.excluirRemove local e vínculos
POST/estabelecimentos/aprovar.phpsessãorec.aprovar / complianceAprova cadastro
POST/estabelecimentos/trocar-representante.phpsessãorec.estabelecimentos.trocar_representanteTroca + log
GET/estabelecimentos/usuarios-trocar-representante.phpsessãonãomesma flagCandidatos à troca
POST/estabelecimentos/vincular-plano.phpsessãorec.editarAssocia plano
GET/estabelecimentos/contatos.phpsessãonãomóduloContatos
GET/estabelecimentos/enderecos.phpsessãonãomóduloEndereços
GET/estabelecimentos/contas-bancarias.phpsessãonãomóduloContas
GET/estabelecimentos/terminais.phpsessãonãomóduloPOS do EC
GET/estabelecimentos/bancos.phpsessãonãomóduloCOMPE
POST/estabelecimentos/sync-bancos.phpsessãorec.móduloSincroniza bancos
GET/POST/estabelecimentos/cnae-cnpj.phpsessãonãomóduloCNAE via CNPJ
GET/POST/estabelecimentos/mcc-cnae.phpsessãonãomóduloDe-para MCC
GET/estabelecimentos/taxas-padrao.phpsessãonãomóduloDefaults p/ cadastro
POST/estabelecimentos/upload-documento.phpsessãosimdocs/KYCUpload (allowlist MIME)
POST/estabelecimentos/criar-painel.phpsessãorec.painelCria user_ec + token de senha
GET/estabelecimentos/painel-existente.phpsessãonãopainelJá existe painel?
POST/estabelecimentos/reenviar-credenciais.phpsessãorec.painelReenvia link de definir senha

Terminais

MétodoPathAuthCSRFFlagDescrição
GET/terminais/listar-locais.phpsessãonãoterminais.*Lista local
GET/terminais/listar-remotos.phpsessãonãomóduloLista adquirente
GET/terminais/terminais-estabelecimento.phpsessãonãomóduloPOS de um EC
GET/terminais/usuarios-vinculo.phpsessãonãomóduloUsuários p/ vínculo
POST/terminais/cadastrar.phpsessãorec.cadastrarCadastro unitário
POST/terminais/cadastrar-lote.phpsessãorec.loteCSV em lote
GET/terminais/download-modelo-csv.phpsessãonãoloteTemplate CSV
POST/terminais/atualizar.phpsessãorec.editarPatch + sync
POST/terminais/excluir.phpsessãorec.excluirRemove
POST/terminais/vincular-dispositivo.phpsessãorec.vínculoTID na adquirente
POST/terminais/desvincular-dispositivo.phpsessãorec.vínculoDesvincula TID

Propostas

MétodoPathAuthCSRFFlagDescrição
GET/propostas/listar.phpsessãonãopropostas.*Lista
GET/propostas/detalhes.phpsessãonãovisualizarFicha
POST/propostas/salvar.phpsessãorec.propostas.criarCria
POST/PUT/propostas/atualizar.phpsessãorec.propostas.editarAtualiza
POST/DELETE/propostas/deletar.phpsessãorec.propostas.excluirExclui
POST/propostas/enviar.phpsessãorec.enviarDispara contrato/fluxo
GET/propostas/taxas.phpsessãonãomóduloTaxas da proposta
GET/propostas/taxas-mensais.phpsessãonãomóduloVisão mensal
GET/propostas/representantes/listar.phpsessãonãomóduloRepresentantes
POST/propostas/representantes/nomes.phpsessãorec.móduloResolve nomes
POST/propostas/representantes/trocar.phpsessãorec.trocarTroca na proposta
GET/propostas/simulador/taxas.phpsessãonãosimuladorTabela p/ simulação
GET/propostas/simulador/calcular.phpsessãonãosimuladorCalcula CET/MCC
GET/POST/propostas/simulador/buscar-mcc.phpsessãonãosimuladorLookup MCC
POST/propostas/simulador/salvar-taxas-base.phpsessãorec.simuladorPersiste base simulada

Comercial / Leads

Módulo de tenant (tenant_modules). CSRF obrigatório em POST. Flags da família leads.* / comercial.read.

MétodoPathCSRFFlagDescrição
GET/comercial/catalogo.phpnãoleads.readStages, sources, reasons
GET/comercial/dashboard.phpnãoleads.readKPIs
GET/comercial/leads.phpnãoleads.read + escopoLista / funil
GET/comercial/detalhes.phpnãoleads.readFicha
POST/comercial/salvar-lead.phpsimleads.create / updateCria/edita
POST/comercial/excluir-lead.phpsimleads.deleteExclui
POST/comercial/mudar-etapa.phpsimleads.stage.changeFunil (ganho/perda)
POST/comercial/atividades.phpsimleads.activities.manageTimeline
GET/POST/comercial/visitas.phpPOST simleads.visits.manageAgenda / check-in
POST/comercial/propostas.phpsimleads.proposals.manageProposta a partir do lead
POST/comercial/routes.phpsimleads.routes.manageGerador de roteiro
GET/comercial/exportar-csv.phpnãoleads.exportCSV
POST/comercial/importar-csv.phpsimleads.importCSV
POST/comercial/importar-documento.phpsimleads.importDoc avulso
POST/comercial/places-search.phpsimleads.import + plataformaGoogle Places busca
POST/comercial/places-import.phpsimleads.import + plataformaImporta lugares
GET/POST/comercial/places-quota.phpPOST simimport / leads.adminCota Places
POST/comercial/converter.phpsimleads.convertLead → EC/proposta
POST/comercial/configuracoes.phpsimleads.adminConfig do módulo
POST/comercial/modulo-white-label.phpsimleads.adminLiga/desliga no tenant
GET/comercial/buscar-cnpj.phpnãoleads.readReceita/CNPJ
GET/comercial/evolucao.phpnãoleads.readEvolução comercial
GET/comercial/monitoramento.phpnãoleads.readFeed 7 dias
GET/comercial/lead-photo.phpnãoleads.readFoto do lead

Tarefas

Módulo de tenant. CSRF em todo POST. index.php = GET lista + POST cria.

MétodoPathCSRFFlagDescrição
GET/tarefas/index.phptarefas.read*Lista paginada
POST/tarefas/index.phpsimtarefas.createCria tarefa
GET/tarefas/show.phpnãoreadDetalhe
POST/tarefas/update.phpsimupdateEdita
POST/tarefas/delete.phpsimdeleteExclui
POST/tarefas/bulk-create.phpsimcreateLote
POST/tarefas/change-status.phpsimstatus (+ regra extra)Kanban/status
GET/tarefas/kanban.phpnãoreadCards (teto 200)
GET/tarefas/kpis.phpnãoreadKPIs
POST/tarefas/step-create.phpsimupdateItem de checklist
POST/tarefas/step-toggle.phpsimupdateMarca passo
POST/tarefas/flow-step-create.phpsimupdateEtapa de fluxo
POST/tarefas/flow-step-delete.phpsimupdateRemove etapa
POST/tarefas/comment-create.phpsimcommentComentário interno
POST/tarefas/document-upload.phpsimupdateAnexo (≤3, 10 MB)
POST/tarefas/ai-summary.phpsimread + OpenAIResumo gpt-4o-mini
POST/tarefas/modulo-white-label.phpsimadminLiga/desliga no tenant

Compliance

MétodoPathAuthCSRFFlagDescrição
GET/compliance/listar.phpsessãonãocompliance.*Fila
GET/compliance/buscar-estabelecimento.phpsessãonãomóduloLookup EC
POST/compliance/criar.phpsessãorec.criarAbre análise
POST/compliance/atualizar-status.phpsessãorec.statusAprova / reprova
POST/compliance/atualizar-documento.phpsessãorec.docsStatus do documento
POST/compliance/atualizar-anotacoes.phpsessãorec.anotarNotas internas
GET/POST/compliance/processar-pendentes.phpsessãorec.processarLote de pendentes

Assinaturas (Autentique)

MétodoPathAuthCSRFFlagDescrição
GET/assinaturas/listar.phpsessãonãoassinaturas.visualizarAtivos
GET/assinaturas/listar-arquivados.phpsessãonãovisualizarArquivo
GET/assinaturas/propostas.phpsessãonãocriarPropostas elegíveis
POST/assinaturas/criar.phpsessãorec.assinaturas.criarEnvia envelope
GET/assinaturas/baixar.phpsessãonãovisualizarDownload
POST/assinaturas/arquivar.phpsessãorec.gerenciarArquiva
POST/assinaturas/desarquivar.phpsessãorec.gerenciarRestaura
POST/assinaturas/excluir.phpsessãorec.excluirRemove
POST/assinaturas/webhook.phpHMACnãoEvento Autentique (público)

Transações

MétodoPathAuthCSRFFlagDescrição
GET/transacoes/listar.phpsessãonãotransacoes.visualizarLista
GET/transacoes/detalhes.phpsessãonãovisualizarFicha
GET/transacoes/dashboard.phpsessãonãodashboardAgregados p/ gráficos
GET/transacoes/exportar-csv.phpsessãonãoexportarCSV
GET/POST/transacoes/polling.phpsessãonãovisualizarIncremental p/ UI
POST/transacoes/log-client.phpsessãonãoLog de erro do browser

Financeiro

MétodoPathAuthCSRFFlagDescrição
GET/financeiro/alugueis/listar.phpsessãonãofinanceiroAluguel de POS
GET/financeiro/comissoes/listar.phpsessãonãocomissõesApuração
GET/financeiro/comissoes/detalhes-estabelecimento.phpsessãonãocomissõesDrill-down EC
GET/financeiro/comissoes/exportar-geral.phpsessãonãoexportarCSV geral
GET/financeiro/comissoes/exportar-estabelecimento.phpsessãonãoexportarCSV por EC
GET/financeiro/comissoes/white-labels-filtro.phpsessãonãocomissõesFiltro WL
GET/financeiro/external/comissoes.phptoken APInãofinance.commissions_readIntegração externa (user_id obrigatório)

Split de pagamentos (frontend/pages/financeiro/split/) é front-only com mock — sem endpoints neste snapshot.

Conta

MétodoPathAuthCSRFFlagDescrição
GET/POST/conta/perfil.phpsessãoPOST rec.própria contaPerfil
POST/conta/senha.phpsessãorec.própria contaTroca senha (política 8+ / maiúsc. / dígito)
GET/POST/conta/configuracoes.phpsessãoPOST rec.super-admin p/ SMTP globalPreferências, Places, Evolution

Vestigial

MétodoPathAuthDescrição
POST/consig/salvar-consignado.phpsessãoConsignado sem tela; não evoluir sem spec

Regenerar OpenAPI

powershell -File tools/generate_openapi.ps1

Depois ajuste este markdown se o verbo ou a flag mudou. O YAML cobre os 191 paths; este arquivo documenta intenção de negócio e autorização.