[DEV-10212] Implementação da API Boleto Cobrança – Integração com Plugboleto

A partir da versão 2.25.1.14053 do MaxManager, foi implementada a integração com a API Plugboleto, fornecida pela Tecnospeed, para automatizar todo o processo de cobrança bancária. A principal novidade desta implementação é a criação do registro “API Boleto Cobrança” no sistema de integrações, permitindo a emissão de boletos, registro automático na carteira de cobrança, liquidação e controle de ocorrências diretamente pelo sistema, eliminando a necessidade de trocas manuais de arquivos com o banco.

Principais vantagens

Registro instantâneo de boletos em mais de 40 bancos homologados, sem necessidade de arquivos manuais.
Boleto recorrente programado e gestão automática de atrasos.
Geração de comprovantes em PDF e importação direta de arquivos de retorno.

Passo a passo de configuração

1. Acessar Configurações

No MaxManager, navegue em Sistema > Painel de Controle > Configuração das Integrações e clique em Adicionar Configuração (botão no canto superior).

2. Adicionar Configuração [API]

Descrição da Configuração: insira um nome descritivo, por exemplo “API Boleto Cobrança”.
Integração [API]: selecione [MaxBoletoCobranca] API Boleto Cobrança.
Clique em Adicionar para abrir a tela de parâmetros.

3. Importar ou preencher parâmetros

Parâmetros da Integração:

Área de arraste/carregamento: opcional para importar um arquivo MaxConfigIntegracao.max existente.
ContentType: application/json (fixo).
CNPJ-SH: CNPJ da Software House.
Token-SH: token de acesso (campo tipo senha; permanece vazio ao importar).

4. Preencher rotas de serviço

Nos blocos Produção e Homologação, insira o domínio completo do Plugboleto mais cada path conforme tabela. Todos os campos são obrigatórios.

Produção:

/api/v1/cedentes
/api/v1/cedentes/contas
/api/v1/cedentes/contas/convenios
/api/v1/certificado
/api/v1/certificado/convenio
/api/v1/certificado/convenio/pix
/api/v1/assinatura
/api/v1/boletos/lote
/api/v1/boletos
/api/v1/boletos/impressao/lote
/api/v1/boletos/impressao/lote
/api/v1/remessas/lote
/api/v1/boletos/descarta/lote
/api/v1/boletos/altera/lote
/api/v1/boletos/altera/individual
/api/v1/boletos/baixa/lote
/api/v1/boletos/baixa/lote
/api/v1/retornos
/api/v1/retornos
/api/v1/assinaturas/boletos/remessa
/api/v1/assinaturas

Homologação:

/api/v1/cedentes
/api/v1/cedentes/contas
/api/v1/cedentes/contas/convenios
/api/v1/certificado
/api/v1/certificado/convenio
/api/v1/certificado/convenio/pix
/api/v1/assinaturas
/api/v1/boletos/lote
/api/v1/boletos
/api/v1/boletos/impressao/lote
/api/v1/remessas/lote
/api/v1/boletos/descarta/lote
/api/v1/boletos/altera/lote
/api/v1/boletos/altera/individual
/api/v1/boletos/baixa/lote
/api/v1/boletos/baixa/lote
/api/v1/retornos
/api/v1/retornos
/api/v1/assinaturas/boletos/remessa
/api/v1/assinaturas

5. Finalizar e salvar

Clique em Salvar. O sistema gerará automaticamente o arquivo oculto MaxConfigIntegracao.max na pasta raiz do servidor. Para conferência, habilite a exibição de arquivos ocultos no servidor.

Arquivo importável: MaxConfigIntegracao.max

Para acelerar a configuração, é possível importar um arquivo .max pré-gerado. Ele contém, de forma criptografada, todas as credenciais (exceto o token) e rotas, sem expor dados sensíveis.

Formato: JSON criptografado com extensão .max.
Campos carregados: ContentType, CnpjSh, CnpjCedente, todas as rotas de Produção e Homologação.
Token-SH: não é importado; deve ser inserido manualmente após a importação.

Exemplo de JSON pré-criptografia

json{
  "MaxConfigIntegracao": {
    "PlugBoleto": {
      "ContentType": "application/json",
      "CnpjSh": "12232522000106",
      "CnpjCedente": "12232522000106",
      "RotasProducao": {
        "Cedente": "/api/v1/cedentes",
        "Conta": "/api/v1/cedentes/contas",
        "Convenio": "/api/v1/cedentes/contas/convenios",
        "Certificado": "/api/v1/certificado",
        "Assinatura": "/api/v1/assinatura",
        "IncluirBoleto": "/api/v1/boletos/lote",
        "ConsultarBoleto": "/api/v1/boletos",
        "SolicitarPDF": "/api/v1/boletos/impressao/lote",
        "GerarArquivoRemessa": "/api/v1/remessas/lote",
        "UploadArquivoRetorno": "/api/v1/retornos",
        "ListarBoletosAssinatura": "/api/v1/assinaturas"
      },
      "RotasHomologacao": {
        "Cedente": "/api/v1/cedentes",
        "Conta": "/api/v1/cedentes/contas",
        "Convenio": "/api/v1/cedentes/contas/convenios",
        "Certificado": "/api/v1/certificado",
        "Assinatura": "/api/v1/assinatura",
        "IncluirBoleto": "/api/v1/boletos/lote",
        "ConsultarBoleto": "/api/v1/boletos",
        "SolicitarPDF": "/api/v1/boletos/impressao/lote",
        "GerarArquivoRemessa": "/api/v1/remessas/lote",
        "UploadArquivoRetorno": "/api/v1/retornos",
        "ListarBoletosAssinatura": "/api/v1/assinaturas"
      }
    }
  }
}

Pontos de atenção

Obrigatoriedade: todos os campos de credenciais e rotas devem ser preenchidos.
Validação: rotas incompletas ou mal formatadas bloqueiam a comunicação.
Segurança: o token permanece protegido e só aparece como campo de senha.

Para mais detalhes dessa nova funcionalidade, acesse:

[DEV-9357] Tela de Cadastro de Integrações Disponíveis | API

[DEV-9358] Tela de Configuração das Integrações | API