API para geração de boleto em PDF e salvamento no S3

🔧 API

Rota para gerar boleto

Exemplo de Request para gerar um boleto

POST http://localhost:3000/api/boleto
Content-Type: application/json

body:
    {
        "cpf": "33333333333",
        "valor": "3000",
        "nossoNumero": "1234567",
        "numeroDocumento": "123123",
        "cedente": "Pagar.me",
        "cedenteCnpj": "18727053000174",
        "agencia": "3978",
        "codigoCedente": "6404154",
        "carteira": "102"
    }

O boleto irá ser gerado nesse formato:

Em seguida é salvo no S3 com o nome:

boleto-CPF_DO_PAGADOR.pdf

e retornado a url de download

Retorno do request

{
    "url": "http://localhost:3000/api/boleto/33333333333"
}

Rota para deletar boleto do S3

Exemplo Request

DELETE https://localhost:3000/api/boleto/CPF_DO_PAGADOR

Retorno do request

É retornando um código de status http 204

🧩 Como executar

Abra o terminal do seu computador. Se estiver no Windows pode ser o CMD ou Powershell;
Altere o diretório de trabalho atual para o local em que deseja ter o código da API salvo;
instale o git e o node no seu computador;
Faça um clone desse repositório rodando:
git clone https://github.com/leosantosx/gerador-boleto.git;
Entre na pasta rodando pelo terminal: cd gerador-boleto;
Rode npm install para instalar as dependências do projeto;
Rode npm run dev para iniciar o servidor de desenvolvimento.

🚀 Tecnologias utilizadas

O projeto foi desenvolvido utilizando as seguintes tecnologias:

📝 Licença

Este projeto está sob a licença MIT. Consulte LICENÇA para obter detalhes.