Contratos de API Interna
Convencoes gerais
- Endpoints ficam majoritariamente em
/src/api/*
- Resposta padrao: JSON
- Autenticacao: sessao PHP
- Middleware comum para APIs: auth_api.php
- Muitos endpoints fazem validacao de perfil no proprio arquivo
Endpoints por dominio
Dashboards e indicadores
| Endpoint |
Metodo |
Objetivo |
/dashboard_data.php |
GET |
KPIs consolidados, aging e tabelas de recebimento |
/src/api/abertos_trend.php |
GET |
tendencia de abertos |
/src/api/aging_anual.php |
GET |
bucketizacao anual |
/src/api/receb_tipoparc_trend.php |
GET |
recebimentos por tipo/parcela |
/src/api/inadimplencia_trend.php |
GET |
evolucao da inadimplencia |
/src/api/inadimplencia_residencial.php |
GET |
distribuicao por residencial |
/src/api/ranking_cobradores.php |
GET |
ranking da equipe |
/src/api/dashboard_digital/*.php |
GET |
KPIs do painel executivo |
Parametros recorrentes:
data_inicio
data_fim
adv_filter
Carteira e distribuicao
| Endpoint |
Metodo |
Objetivo |
/src/api/carteira.php |
GET |
lista da carteira com atribuicao |
/src/api/resumo_distribuicao.php |
GET |
KPIs por cobrador |
/src/api/distribuir_pendentes.php |
POST/GET operacional |
distribui carteira pendente |
/src/api/atribuir.php |
POST |
atribui cliente a cobrador |
/src/api/historico_atribuicao.php |
GET |
historico de atribuicoes |
/src/api/remover_atribuicao.php |
POST |
remove/desativa atribuicao |
Fluxo 30 dias
| Endpoint |
Metodo |
Objetivo |
/src/api/cobranca30/registrar.php |
POST |
registra item no fluxo 30 dias |
/src/api/cobranca30/check_flags.php |
GET |
verifica flags do cliente/titulo |
/src/api/cobranca30/marcar_pago.php |
GET/execucao interna |
processa pagamentos |
/src/api/indicadores_30dias.php |
GET |
consolida metricas do painel 30 dias |
Contrato observado em registrar.php:
{
"cpf_cnpj": "somente-digitos",
"proposta": "numero-ou-codigo",
"data_vencimento": "YYYY-MM-DD",
"valor": 123.45,
"advogado": 0
}
Renegociacao e recebimentos
| Endpoint |
Metodo |
Objetivo |
/src/api/indicadores_renegociacao.php |
GET |
dados do painel de renegociacao |
/src/api/pc_titulos_pagos.php |
GET |
recebidos de renegociacao |
/src/api/pc_titulos_pagos_30d.php |
GET |
recebidos 30 dias |
/src/api/pc_titulos_pagos_adv.php |
GET |
recebidos advogado |
/src/api/pc_recebimento_por_tipo.php |
GET |
composicao por tipo |
Observacoes atuais:
pc_titulos_pagos_30d.php passou a reclassificar itens Travessia a partir da observação SQL Server, marcando origem chronos e empresa Travessia
- o endpoint legado
/src/api/pc_valor_recebimentos.php saiu de uso nesta trilha e não deve voltar ao pacote de promoção sem revisão explícita
Sincronizacao Chronos / painel Sinc
| Endpoint |
Metodo |
Objetivo |
/src/api/chronos_sync_status.php |
GET |
status resumido da sync local |
/src/api/chronos_sync_compare.php |
GET |
comparativo Base local x API por data |
/src/api/chronos_sync_logs.php |
GET |
leitura dos logs operacionais |
/src/api/chronos_sync_recheck.php |
POST/GET |
dispara recheck manual e consulta andamento |
/src/api/chronos_sync_schedule.php |
GET/POST |
lê e grava agendamentos da sync |
Contrato observado em chronos_sync_recheck.php:
{
"date": "2026-04-22",
"credit_ids": [141279, 141899]
}
Resposta inicial esperada:
{
"ok": true,
"data": {
"queued": true,
"run_id": 130,
"scope_reference": "manual-recheck-date-20260422-abcdef",
"credit_count": 2
}
}
Consulta de andamento:
GET /src/api/chronos_sync_recheck.php?run_id=130
- fallback compatível:
GET /src/api/chronos_sync_recheck.php?scope_reference=...
Lembretes e historico operacional
| Endpoint |
Metodo |
Objetivo |
/src/api/lembretes/hoje.php |
GET |
lembretes do dia |
/src/api/lembretes/pendentes.php |
GET |
backlog de lembretes |
/src/api/lembretes/concluir.php |
POST |
conclui lembrete |
/src/api/lembretes/reagendar.php |
POST |
reage nda lembrete |
/src/api/triagem/registrar_historico.php |
POST |
injeta historico de triagem |
Clientes inativos / carteira saudavel
| Endpoint |
Metodo |
Objetivo |
/src/api/carteira_saudavel_indicadores.php |
GET |
indicadores de carteira saudavel |
/src/api/clientes_inativos_listar.php |
GET |
paginacao dos inativos |
/src/api/clientes_inativos_marcar.php |
POST |
marca cliente como inativo |
/src/api/clientes_inativos_remover.php |
POST |
reativa/remove da base de inativos |
/src/api/clientes_buscar_sqlserver.php |
GET |
busca candidatos no SQL Server |
Documentos do cliente
| Endpoint |
Metodo |
Objetivo |
/src/api/documentos/listar.php |
GET |
lista documentos por CPF |
/src/api/documentos/upload.php |
POST multipart |
envia documento |
/src/api/documentos/remover.php |
POST/DELETE |
remove documento |
/src/api/documentos/download.php |
GET |
baixa arquivo |
/src/api/documentos/pacote_zip.php |
GET |
gera ZIP por cliente |
Usuarios e autenticacao
| Endpoint |
Metodo |
Objetivo |
/src/api/auth/token_login.php |
variavel |
autenticacao auxiliar |
/src/api/usuarios_listar.php |
GET |
lista ou detalha usuario |
/src/api/usuarios_criar.php |
POST |
cria usuario |
/src/api/usuarios_atualizar.php |
POST |
atualiza usuario |
/src/api/usuarios_excluir.php |
POST |
exclui usuario |
/src/api/alterar_senha.php |
POST |
troca senha |
IA e texto
| Endpoint |
Metodo |
Objetivo |
/src/api/texto/config_obter.php |
GET |
carrega configuracao de IA |
/src/api/texto/config_salvar.php |
POST |
salva configuracao de IA |
/src/api/texto/revisar_observacao.php |
POST |
revisa texto com IA |
/src/api/contatos_ia_resumo.php |
GET |
resumo assistido por IA |
Juridico
| Endpoint |
Metodo |
Objetivo |
/src/api/juridico/check.php |
GET |
consulta status juridico |
/src/api/juridico/encaminhar.php |
POST |
encaminha para juridico e registra historico |
/src/api/juridico_parcelas_por_proposta.php |
GET |
detalhe de parcelas da proposta |
Base de conhecimento
| Endpoint |
Metodo |
Objetivo |
/src/api/kb/SearchApi.php |
GET |
busca artigos |
/src/api/kb/ArticleApi.php |
GET |
detalha artigo por slug |
/src/api/kb/RelatedApi.php |
GET |
relacionados por rota |
/src/api/kb/AdminApi.php |
POST JSON |
CRUD administrativo |
/src/api/kb/MediaApi.php |
POST/DELETE |
upload e remocao de midia |
Observacoes para evolucao
- Nao ha definicao OpenAPI ou swagger.
- O contrato real de varias APIs e o proprio JavaScript consumidor.
- Ao alterar payloads, revisar simultaneamente:
- pagina PHP que renderiza os placeholders
- JS da pagina
- endpoint PHP
- tabela MySQL auxiliar, quando houver