API
- Cadastro de Cliente (/ws/cadastrarBoleto.xhtml method=POST)
- Lista de Clientes (/ws/listaCliente.xhtml method=POST)
- Geração de Boletos (/ws/gerarBoleto.xhtml method=POST)
- Registro de Boletos (/ws/registrarBoleto.xhtml method=POST)
- Pesquisa de Boletos (/ws/pesquisarBoleto.xhtml method=POST)
- Impressão de Boletos (/ws/imprimirBoleto.xhtml method=POST)
- Baixar boleto (/ws/baixarBoleto.xhtml method=POST)
- Exclusão de Boletos (/ws/excluirBoleto.xhtml method=POST)
Utilização
- A URL Base da API
[http://sindical.rtools.com.br:7080/boletoOnline/ws/)
- Envio de Requisição
Deve ser feito via POST, com HEADER e QUERY.
- Formato de Retorno
O retorno das requisições são no formato JSON (application/json).
- Bancos Disponíveis
Banco do Brasil
Bradesco
Caixa Econômica Federal
Itaú
Santander
Sicoob
01 – Sistema cadastra um cliente
02 – Sistema cria um boleto
03 – Sistema registra um boleto
04 – Sistema imprime o boleto
Cadastro de Clientes
Formulário com dados básicos para a criação e alteração de cliente na base de dados.
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"codigo" : 0,
"mensagem" : "Cadastro Salvo com Sucesso"
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Lista de Clientes
Lista os clientes cadastrados, com possibilidades de filtragem.
- URL de Requisição
- Exemplo de resposta:
[
{
"id": 33,
"nome": "JOÃO BOLETO DA SILVA",
"documento": "354.614.980-78",
"email": "joaoboleto@email.com",
"telefone": "(99) 8877-7766",
"cidade": {
"id": 9518,
"cidade": "Ribeirão Preto",
"uf": "SP"
},
"cep": "14020-600",
"endereco": "RUA MARIA DAS GRAÇAS, 987 - APTO 15",
"bairro": "CENTRO"
}
]{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Geração de Boletos
Cria boletos no sistema, não registrados inicialmente.
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"id": 130,
"nossoNumero": "14000000000000027",
"ativo": true
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Registro de Boletos
Registra uma lista de boletos criados no sistema.
Registra apenas um boleto individual criado no sistema.
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"codigo": 0,
"mensagem": "Boleto Registrado!"
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Pesquisa de Boletos
Pesquisa um boleto individualmente.
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"id": 130,
"nossoNumero": "14000000000000027",
"ativo": true
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Impressão de Boletos
Cria um arquivo no sistema com o boleto previamente registrado, retorna um link com o arquivo em pdf para visualização.
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"codigo": 0,
"mensagem": "http://sindical.rtools.com.br:7080/boletoOnline/resources/downloads/Boleto_9c0e620c-c200-4021-a06b-cf1805.pdf"
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Baixa de Boletos
Baixa boleto do sistema ( marca como boleto pago ).
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"codigo": 0,
"mensagem": "Boleto baixado com Sucesso!"
}
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}
Exclusão de Boletos
Exclui um boleto do sistema ( apenas boletos que não foram registrados podem ser excluídos ).
- URL de Requisição
- Exemplo de resposta para SUCESSO:
{
"codigo": 0,
"mensagem": "Boleto excluído com Sucesso!"
}
- Exemplo de resposta para ERRO:
{
"codigo" : 1,
"mensagem" : "*MENSAGEM PERSONALIZADA DE ACORDO COM O ERRO*"
}