Fork me on GitHub

correios-api
by Guilherme Chapiewski

correios-api é uma API para acessar informações de rastreamento de pacotes dos Correios.

Você pode usar a API tanto como um uma RubyGem para projetos Ruby ou como um webservice REST para usar as informações em outras linguagens diferentes de Ruby.

Download

A forma mais fácil de usar a API é instalar o Gem direto do Github:

$ gem sources -a http://gems.github.com
$ sudo gem install guilhermechapiewski-correios-api

Você também pode baixar o projeto no formato zip ou tar se quiser instalar manualmente.

E por último, você também pode clonar o projeto usando Git, executando:

$ git clone git://github.com/guilhermechapiewski/correios-api

Instruções de uso - API Ruby

require "rubygems"
require "correios"

# obtendo as informacoes de uma encomenda
encomenda = Correios.encomenda("ES446391025BR")

puts "Encomenda: #{encomenda.numero}"
puts
encomenda.status.each do |status|
  puts " data: #{status.data}"
  puts " local: #{status.local}"
  puts " situacao: #{status.situacao}"
  puts " detalhes: #{status.detalhes}"
  puts
end

Instruções de uso - API REST

Digite:

$ correios-api

Este comando irá iniciar a API REST na port 4567. Basta acessar o recurso "encomenda" informando o núnero de restreamento para obter as informações:

http://localhost:4567/encomenda/ES446391025BR

O GET irá retornar um XML conforme abaixo:

<encomenda numero="ES446391025BR">
  <status data="2009-01-27T16:35:00+00:00">
    <local>ACF FENIX - ITAPECERICA DA SERRA/SP</local>
    <situacao>Postado</situacao>
    <detalhes></detalhes>
  </status>
  <status data="2009-01-27T18:51:00+00:00">
    <local>ACF FENIX - ITAPECERICA DA SERRA/SP</local>
    <situacao>Encaminhado</situacao>
    <detalhes>Em trânsito para CTE JAGUARE - SAO PAULO/SP</detalhes>
  </status>
  ...
</encomenda>

Para mais instruções de uso veja os arquivos "DOCUMENTACAO.txt" e "exemplo_de_uso.rb".

Desenvolvimento

correios-api é um projeto open-source desenvolvido por Guilherme Chapiewski sob a licensa Apache License 2.0. É desenvolvido inteiramente em Ruby no Mac OS X com Textmate e os frameworks Sinatra e hpricot.