gabrielboliveira / rest-tracking

API REST para abstrair os métodos do pacote tracking-correios.

rest-tracking

API REST para abstrair o método track do pacote tracking-correios.

Pré-requisitos

• Node.js (versão 0.12 a latest)
• npm

Instalação

# ssh
$ git clone [email protected]:gabrielboliveira/rest-tracking.git

# https
$ git clone https://github.com/gabrielboliveira/rest-tracking.git

$ cd rest-tracking
$ npm install
$ node start

A configuração da porta padrão (3000) é feita no arquivo env.json.

Uso

A API expõe o endpoint /track para obter os dados de rastreio dos pacotes. Recebe um objeto com atributo codes e um array de códigos:

{
    "codes": ["DU123123123BR"]
}

Exemplo:

$ curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X POST -d '{"codes": ["DU123123123BR"]}' http://localhost:3000/track

> HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 101
Date: Tue, 03 Jan 2017 12:29:09 GMT
Connection: keep-alive

{"data":[{"numero":"DU123123123BR","erro":"Objeto não encontrado na base de dados dos Correios."}]}

Produção

Para executar a API em produção é recomendado um process manager como por exemplo PM2 ou forever.

$ npm run build-prod
$ pm2 start prod/track.js --name="rest-tracking"

Testes

Para desenvolvimento, foram desenvolvidos testes unitários e E2E. Para executá-los, deve rodar o seguinte script:

$ npm test

Licença

MIT.