GoCorreios Server

Api to serve correios services in a easy way 📖

Made with Golang 🚀

Installation and execution   |    Available Routes   |    How to contribute   

🚀 Installation and execution

1. Clone this repository and go to the directory;
2. Rename sample .env;

🔧 Development

1. Run docker-compose up;
2. Make the Requests;

🧪 Tests

1. Run docker-compose -f docker-compose.test.yml up --build --abort-on-container-exit;

🛣️ Available Routes

POST - Create Fare:

• /fares
  Expected Json Body Request:
  

{
  "service": "SEDEX",
  	"cep_destination": "09981380",
  	"cep_origin": "09981380",
  	"height": "15",
  	"lenght": "15",
  	"weight": "1",
  	"width": "15",
}

Expected Json Response:

{
  "service": "SEDEX",
  	"price": "22,50",
  	"days_for_delivery": "3",
  	"deliver_home": "N",
  	"deliver_saturday": "S",
  	"obs": "O CEP de destino está temporariamente sem entrega domiciliar. A entrega será efetuada na agência indicada no Aviso de Chegada que será entregue no endereço do destinatário."
}

🤔 How to contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: My new feature';
• Push to your branch: git push origin my-feature.

After the merge of your pull request is done, you can delete your branch.

---