Como gerar boletos com registro via API

Neste Post vamos explicar como você pode gerar seus boletos utilizando nossa API.

A API Boletomail foi pensada para ser de implementação fácil. Para gerar um boleto, basta informar os parâmetros desejados na URL do boleto.

Ao gerar o boleto pela nossa API, o arquivo-remessa é gerado automaticamente no sistema, desta forma você não precisa se preocupar em gerar este tipo de arquivo para enviar ao banco.

Desta forma, temos 2 métodos para gerar o boleto, o primeiro é o mais fácil, mas pode permitir alteração dos valores (valor, vencimento) do boleto, pois eles ficam expostos na URL.  Na segunda forma, não há esta possibilidade, por isso ela é mais segura, mas requer um passo a mais que na primeira forma.

Se durante seus testes, você receber a mensagem de Erro “Referer Vazio”, basta solicitar a liberação para gerar boletos por URL no atendimento@boletomail.com.br

Forma 1: Informar parâmetros na URL do boleto

Abaixo segue uma URL que gera um boleto com registro:

https://www.boletomail.com.br/do.php?v_dia=11&v_mes=8&v_ano=2017&valor=123
&tipo_pessoa=CPF&numero=12345678901
&nome=Jose+da+Silva&mailto=jose%40gmail.com
&obj-cliente-cep=05419000&obj-cliente-endereco=Avenida+Pedroso+de+Morais
&obj-cliente-numero=677&obj-cliente-complemento=CJ+93
&obj-cliente-bairro=Pinheiros&obj-cliente-cidade=Sao+Paulo
&obj-cliente-uf=SP
&user=vamonessa
&action=3

Abaixo, segue a explicação de cada campo:

valor 125,98 Valor do boleto – informar SEM símbolos e sem separador de milhar.
v_dia 31 Dia do vencimento do boleto.
v_mes 12 Mês do vencimento do boleto.
v_ano 2000 Ano do vencimento do boleto (com quatro dígitos).
user vamonessa Seu username no Sistema Boletomail
action 3 1
para display (apenas gera o boleto on line)
2   para email (apenas manda o boleto via email sem display)3   para
display+email (gera o boleto on line e envia via email)
nome Figueiredo+Ferraz  (*) Nome do sacado
cod_cli 123-AG(*) Código do cliente que o identifica no seu sistema. É usado para você controlar mais facilmente os boletos pagos.
mailto fferraz@dot.com(*) Email do sacado, necessário no caso de action=2 ou action=3.
tipo_pessoa CPF ou CNPJ Informar a literal CPF ou CNPJ
numero 12345678901 Número do CPF/CNPJ
obj-cliente-cep 05419000 CEP do sacado
obj-cliente-endereco Av Pedroso de Morais Endereço do sacado
obj-cliente-numero 677 Número do endereço
obj-cliente-complemento CJ 93 Complemento do endereço
obj-cliente-bairro Pinheiros Bairro do endereço
obj-cliente-cidade São Paulo Cidade do endereço
obj-cliente-uf SP UF do endereço – Informar com 2 Caracteres, ou seja PR ao invés de PARANA
chkInserir true Informar true se deseja cadastrar os dados do sacado no cadastro de clientes do sistema
instr Não+receber+após+

o+vencimento   (*)

Instruções
– no caso de ser informado, substitui as constantes no boletoServer
numdoc2 552626 Número do documento
d_dia 12 Dia da data do documento
d_mes 11 Mês da data do documento
d_ano 2020 Ano da data do documento (4 digitos)
p_dia 13 Dia da data de processamento
p_mes 11 Mês da data de processamento
p_ano 2020 Ano da data de processamento (4 digitos)
cod_config 0 Código de configuração do Boletomail
Se você tem mais de uma configuração no BoletoMail, você deve informar seu código de configuração.
Para a maioria dos cliente BoletoMail este campo deve ser deixado em
branco.

(*)Todos os caracteres não-alfanuméricos desses campos devem ser codificados conforme o padrão application/x-www-form-urlencode (no PHP usar a função urlencode)

Forma 2: Obter a URL e fazer redirect para a URL obtida (forma recomendada)

A segunda forma é muito parecida com a primeira forma. A única diferença é que ao invés de gerar o boleto. O sistema Boletomail gerará um link encurtado, que ao ser aberto, exibe o boleto gerado com os parâmetros da URL. Desta forma, os parâmetros que foram utilizados para gerar o boleto não ficam visíveis para manipulação do usuário.

Para isso, basta colocar o valor action=5 na URL, como no exemplo:
https://www.boletomail.com.br/do.php?v_dia=11&v_mes=8&v_ano=2017&valor=123
&tipo_pessoa=CPF&numero=12345678901
&nome=Jose+da+Silva&mailto=jose%40gmail.com
&obj-cliente-cep=05419000&obj-cliente-endereco=Avenida+Pedroso+de+Morais
&obj-cliente-numero=677&obj-cliente-complemento=CJ+93
&obj-cliente-bairro=Pinheiros&obj-cliente-cidade=Sao+Paulo
&obj-cliente-uf=SP
&user=vamonessa
&action=5

Ao abrir este link, o sistema responderá com um link encurtado, como o exemplo:

https://www.boletomail.com.br/do.php?hash=CURELO-LOLADA-GOCOLI

Este link, ao ser aberto gerará o boleto previamente configurado.
Abaixo mostramos códigos-fonte sobre sugestão de como fazer o redirect para exibir o boleto:

PHP:
/* abre a url com os parametros do boleto */
$nossonum = 123456;
$valor = ‘123,45’;
$v_dia = 31;
$v_mes = 12;
$v_ano = 2012;
$user=’vamonessa’;
$nome = ‘Roberto da Silva’;
$endereco = ‘Av Pedroso de Morais, 677 Cj 143’;
$endereco2 = ‘05419-000 Sao Paulo – SP’;
$sacado = urlencode(“$nome
$endereco
$endereco2”);
$url = “http://www.boletomail.com.br/do.php?nome=$sacado&nossonum=nossonum&valor=$valor&v_dia=$v_dia&v_mes=$v_mes&v_ano=$v_ano&user=$user&action=5”;
//echo $url;exit();
$fd=fopen ($url, “r”);
if (!$fd){
die(“Erro, verifique se a url fornecida esta correta.”);
}else{
while(!feof($fd)){
$urlBoleto .= trim(fgets($fd, 4096));
}
/* redireciona para o boleto */
header(“Location: “.$urlBoleto);
}
ASP:
Dim objInet As Inet
Set objInet = New Inet
strUrlBoleto = objInet.OpenURL(“http://www.boletomail.com.br/do.php?nossonum=123456&valor=125,98&v_dia=31&v_mes=12&v_ano=2010&user=vamonessa&action=5”)
Response.Redirect(strUrlBoleto)

Esse post foi publicado em Dicas Boletomail. Bookmark o link permanente.

Deixe um comentário