Referência Técnica para equipe de Tecnologia da Informação

Tabelas de endpoints, rotas, auditoria, integrações externas e dependências — material de consulta rápida para equipes de tecnologia.

Em linguagem simples

Esta página é um dicionário técnico para a equipe de Tecnologia da Informação Ela lista todas as "portas" do sistema (endpoints), onde os dados ficam guardados e como auditar o que aconteceu.

Se você é operador ou gestor, os capítulos anteriores já têm o que precisa. Esta página é para quem instala, configura e dá suporte ao sistema.

Mapa de módulos e rotas

Identificador Universal Único	Classe	Rota base
`981bfb94-afe7-4956-8ecd-4ecbc3b45246`	`api_integracao_credsystem`	`/bibliotecas/981bfb94-…/api_integracao_credsystem`
`88e14c87-331c-485b-95f8-8f63d76d446d`	`api_integracao_credsystem_pagamento_total`	`/bibliotecas/88e14c87-…/api_integracao_credsystem_pagamento_total`
`857e21c5-203f-4943-b60d-9258bf0ebd7e`	`credsystem_gestor_configuracoes`	`/bibliotecas/857e21c5-…/credsystem_gestor_configuracoes`

Integrações externas

Sistema	Protocolo	Endereço Uniforme de Recurso (homologação)
Autorização Aberta Oracle IDCS	POST client_credentials	`https://idcs-…identity.oraclecloud.com/oauth2/v1/token`
Credsystem Arrecadação	Transferência Representacional de Estado versão 2	`https://apihml.credsystem.com.br/arrecadacao-lojista/api/v2/`
Credsystem Venda-loja	Transferência Representacional de Estado versão 1	`https://apihml.credsystem.com.br/venda-loja/api/v1/`
ILLI Ponto de Venda	Pré-processador de Hipertexto interno	`vendarapida::sangriasuprimento`
Totem de Pagamento Instantâneo Interface do Usuário	redirecionamento do Protocolo de Transferência de Hipertexto	`/v1/credsystem-pix`

Autorização Aberta client_id e client_secret estão no código de 981bfb94 — parametrizar para produção; não expor em documentação.

Endpoints — Interface de Programação de Aplicações Credsystem (981bfb94)

Método Pré-processador de Hipertexto	Protocolo de Transferência de Hipertexto	Endpoint Credsystem
`consultarTitulos`	GET	`consulta-titulo`
`preAutorizar`	POST	`pre-autorizacao`
`preAutorizarPix`	POST	`pre-autorizacao/pix`
`consultarStatusPreAutorizacao`	GET	`pre-autorizacao/sonda/status`
`consultarStatusPreAutorizacaoPix`	GET	`pre-autorizacao/sonda/status-pix`
`efetivar`	POST	`efetivacao`
`consultarSondaEfetivacao`	GET	`efetivacao/sonda`
`desfazer`	POST/GET	`desfazimento`
`consultarFaturas`	GET	`faturas`
`consultarExtrato`	GET	`faturas/extrato/{cod}/vencimento/{data}`
`consultarTransacoes`	GET	`faturas/extrato/…/transacoes`
`consultarLimiteSituacao`	GET	`limite-situacao` (cabeçalho `cpf`)
`contratarPlanoVenda`	POST	`venda`
`pagamento`	—	Orquestra: títulos → pré-autorização → efetivação → sonda
`pagamentoPix`	—	Orquestra fluxo Pagamento Instantâneo com verificação periódica de status
`getConfiguracaoCredsystem`	—	Lê `configuracao_entidade`
`salvarConfiguracaoCredsystem`	—	Grava `api_config_credsystem`

Endpoints — Pagamento Total (88e14c87)

Método Pré-processador de Hipertexto	Efeito colateral
`consultarTitulos`	Interface de Programação de Aplicações + INSERT `cred_cliente`
`consultarLimiteSituacao`	Delega 981bfb94
`contratarPlanoLimite`	Delega 981bfb94
`pagamentoTotal`	Interface de Programação de Aplicações + `cred_pagamento` + receita no Ponto de Venda + auditoria
`preAutorizacaoPix`	Interface de Programação de Aplicações + auditoria de Pagamento Instantâneo
`consultarStatusPixPagamento`	Delega 981bfb94
`confirmarRecebimentoPix`	`cred_pagamento` (Pagamento Instantâneo) — sem receita no Ponto de Venda
`desfazerPagamento`	Interface de Programação de Aplicações desfazer + `ESTORNADO` + despesa no Ponto de Venda
`listarPagamentosCredsystemIntegrador`	SELECT `cred_pagamento` (filtros 24h, não-Pagamento Instantâneo)
`registrarControleImpressao`	Auditoria impressão correta
`registrarControleImpressaoIncorreta`	Auditoria impressão incorreta
`registrarSatisfacaoTotem`	INSERT `cred_satisfacao`
`autenticacaoTotem`	Protocolo de Transferência de Hipertexto código 302 → `/v1/credsystem-pix`
`obter/salvar/limpar/exibirFundoTotemAtracao`	Criar, Ler, Atualizar e Excluir imagem totem

Banco de dados

Tabela / Chave	Módulo	Uso
`configuracao_entidade.api_config_credsystem`	981bfb94	Configuração por loja (Codificação Base 64)
`configuracao_usuario.gestor_configuracao_caixa`	857e21c5	Caixa por usuário
`configuracao_usuario.gestor_configuracao_impresora`	857e21c5	Impressora por usuário
`configuracao.credsystem_pix_fundo_totem_atracao`	88e14c87	Imagem fundo totem
`{banco}_integrador.cred_cliente`	88e14c87	Dados cliente (Notação de Objetos JavaScript)
`{banco}_integrador.cred_pagamento`	88e14c87	Histórico pagamentos
`{banco}_integrador.cred_satisfacao`	88e14c87	índice de satisfação do totem (1–5)

Auditoria (controle)

Método controle() em 88e14c87 registra eventos com campo tipo:

tipo	Quando
`credsystem-recebimento-pagamento`	Pagamento convencional efetivado
`credsystem-pix-pre-autorizacao`	Código de Resposta Rápida Pagamento Instantâneo gerado
`credsystem-recebimento-pix`	Pagamento Instantâneo confirmado
`credsystem-estorno-pagamento`	Desfazimento realizado
`credsystem-comprovante-impressao`	Comprovante impresso corretamente
`credsystem-comprovante-impressao-incorreta`	Erro na impressão

Regras de negócio (constantes)

Regra	Valor	Arquivo
Prazo estorno	24 horas	`88e14c87/controle.php` — `PRAZO_DESFAZIMENTO_HORAS`
Pagamento Instantâneo estornável	Não	Filtro Linguagem de Consulta Estruturada `pagamento <> 'PIX'`
Pagamento Instantâneo gera receita no Ponto de Venda	Não	`confirmarRecebimentoPix` sem `registrarReceita`
Estorno automático em falha	Default true	`estornarEmFalha` em `pagamento()`
Consulta repetida de Pagamento Instantâneo pendente	Protocolo de Transferência de Hipertexto código 202	`consultarStatusPreAutorizacaoPix`

Dependências compartilhadas

APPPATH/controllers/bibliotecas/12262a22-30ab-11e9-bb4c-127101af6b0d/util.php — utilitários de banco de dados, entidades e consultas
APPPATH/controllers/pdv/vendarapida.php — sangria/suprimento (receita/despesa)
APPPATH/controllers/biblioteca.php — classe base biblioteca
Guzzle para Protocolo de Transferência de Hipertexto — usado em 981bfb94 para chamadas de Transferência Representacional de Estado

Arquivos-fonte principais

Arquivo	Linhas aprox.	Conteúdo
`bibliotecas/981bfb94-…/controle.php`	~1700	Cliente de Transferência Representacional de Estado Credsystem completo
`bibliotecas/88e14c87-…/controle.php`	~1710	Orquestração pagamento, Ponto de Venda, totem
`bibliotecas/88e14c87-…/visual.html`	~2000	Portal Vue 3
`bibliotecas/88e14c87-…/instalador.php`	~110	Migrações v1–v4
`bibliotecas/981bfb94-…/visual.html`	—	Config Quasar
`bibliotecas/857e21c5-…/controle.php`	~460	Configuração do gestor

Resumo dependências

Figura 11 — Mapa resumido de módulos e dependências externas ao diretório bibliotecas/.