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

<section class="capitulo" id="bkmrk-tabelas-de-endpoints">Tabelas de endpoints, rotas, auditoria, integrações externas e dependências — material de consulta rápida para equipes de tecnologia.

<section class="para-todos">## 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.

</section><section class="para-ti">## Mapa de módulos e rotas

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

## Integrações externas

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

*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)

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

## Endpoints — Pagamento Total (88e14c87)

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

## Banco de dados

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

## Auditoria (controle)

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

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

## Regras de negócio (constantes)

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

## 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

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

</section>![Resumo dependências](https://kb.illimitar.pro/uploads/images/gallery/2026-06/embedded-image-mm0nklzt.png)

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

</section>