Giter Club home page Giter Club logo

correios-rest's Introduction

Correios Services

Build Status Coverage Status

Uma alternativa simples e fácil para calcular preços e prazos de encomendas dos Correios.

Motivação

Imagine um mundo onde a comunidade define o melhor caminho, projeta e implementa a aplicação dos Correios, melhorando os fluxos de trabalho e tornando as coisas mais fáceis de se trabalhar no front-end. Dos devs para os devs!
(Não é bem implementar a aplicação dos Correios, mas é um "meio de campo". Leia abaixo).

Como funciona

A API recebe o JSON, parseia os dados, faz a requisição no webservice dos Correios e retorna um JSON. Você só precisa fazer um fetch e tratar a resposta.

A ideia é simplificar a vida do desenvolvedor, deixando a responsabilidade de tratar a resposta para a aplicação.


Começando a contribuir

git clone [email protected]:tchaguitos/correios-rest.git

cd correios-services

npm install

nodemon


Contribuindo

Antes de tudo, tome conhecimento do styleguide do Airbnb. Ele vai nos ajudar na padronização do código.

Depois disso, leia o manual de contribuição.


Informações importantes

A lista de serviços disponíveis no webservice dos Correios é a abaixo. Os itens marcados já estão implementados.

  • CalcPrazo
  • CalcPrazoData
  • CalcPrazoRestricao
  • CalcPreco
  • CalcPrecoData
  • CalcPrecoFAC
  • CalcPrecoPrazo
  • CalcPrecoPrazoData
  • CalcPrecoPrazoRestricao
  • ListaServicos

Você pode acompanhar o progresso através das issues e do projeto "correios-services" na aba "projects".

Mais informações referentes aos Serviços você encontra aqui.


Exemplo prático

Para calcular o valor do frete de uma encomenda, basta enviar, através do verbo POST, um JSON contendo as informações abaixo para o endpoint '/v1/price'.
(Sim, essa URL precisa de um nome melhor).

{
  "nCdEmpresa": "",
  "sDsSenha": "",
  "nCdServico": "40010",
  "sCepOrigem": "37410220",
  "sCepDestino": "05311900",
  "nVlPeso": "1",
  "nCdFormato": "1",
  "nVlComprimento": "20",
  "nVlAltura": "5",
  "nVlLargura": "15",
  "nVlDiametro": "0",
  "sCdMaoPropria": "n",
  "nVlValorDeclarado": "100",
  "sCdAvisoRecebimento": "n"
}

Você receberá um JSON contendo a resposta do serviço dos Correios.

{
  "Codigo": "40010",
  "Valor": "49,15",
  "ValorMaoPropria": "0,00",
  "ValorAvisoRecebimento": "0,00",
  "ValorValorDeclarado": "0,75",
  "Erro": "",
  "MsgErro": "",
  "ValorSemAdicionais": "48,40"
}

correios-rest's People

Contributors

tchaguitos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.