joaowicktor/correios-package-tracking

Uma API simples para rastrear os pacotes dos Correios 📦

📦 Correios Package Tracking API

Uma API simples para rastrear os pacotes dos Correios

🚀 Tecnologias

• Express - Um framework web para Node.js
• Axios - Um cliente HTTP baseado em Promises para Browser e Node.js
• Node HTML Parser - Uma biblioteca para manipular a árvore do DOM de forma mais simples

🔧 Pré-requisitos

• Node.js
• Yarn ou npm

🔥 Instalação e execução

1. Clone esse repositório;

$ git clone https://github.com/joaowicktor/correios-package-tracking.git

2. Entre na pasta cd correios-package-tracking;
3. Rode yarn ou npm install para instalar as dependências do projeto;
4. Rode yarn dev ou npm run dev para iniciar o servidor.

⚡ Exemplos

GET /api/track?code=CODIGO_DE_RASTREIO

Caso o código seja válido

{
  "success": true,
  "message": "Encomenda encontrada",
  "data": {
    "packageCode": "AB123456789BR",
    "packageDates": {
      "postDate": "21/01/2020",
      "lastForwarding": "23/01/2020",
      "deliveryForecast": "06/02/2020"
    },
    "packageHistory": [
      {
        "date": "23/01/2020",
        "time": "21:08",
        "local": "CURITIBA / PR",
        "type": "Objeto encaminhado",
        "description": "de Unidade de Tratamento em CURITIBA / PR para Unidade de Tratamento em LONDRINA / PR",
        "from": "Unidade de Tratamento em CURITIBA / PR",
        "to": "Unidade de Tratamento em LONDRINA / PR"
      },
      {
        "date": "22/01/2020",
        "time": "14:52",
        "local": "CURITIBA / PR",
        "type": "Objeto encaminhado",
        "description": "de Agência dos Correios em CURITIBA / PR para Unidade de Tratamento em CURITIBA / PR",
        "from": "Agência dos Correios em CURITIBA / PR",
        "to": "Unidade de Tratamento em CURITIBA / PR"
      },
      {
        "date": "22/01/2020",
        "time": "13:06",
        "local": "CURITIBA / PR",
        "type": "Objeto postado",
        "description": ""
      }
    ]
  }
}

Caso o código seja inválido

{
  "success": false,
  "errorCode": 404,
  "message": "O código não existe ou já passaram 180 dias após a data de postagem"
}

---

Feito com ❤️ por João Wicktor 👋