Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duduribeiro/correios_sigep
Correios SigepWeb Integration
https://github.com/duduribeiro/correios_sigep
correios correios-sigepweb hacktoberfest logistica-reversa
Last synced: 3 months ago
JSON representation
Correios SigepWeb Integration
- Host: GitHub
- URL: https://github.com/duduribeiro/correios_sigep
- Owner: duduribeiro
- License: mit
- Created: 2015-02-27T17:40:39.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-29T19:24:44.000Z (over 4 years ago)
- Last Synced: 2024-04-15T04:19:36.677Z (10 months ago)
- Topics: correios, correios-sigepweb, hacktoberfest, logistica-reversa
- Language: Ruby
- Homepage:
- Size: 1.19 MB
- Stars: 14
- Watchers: 7
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
CorreiosSigep
=============
[](https://travis-ci.org/duduribeiro/correios_sigep)
[](https://coveralls.io/github/duduribeiro/correios_sigep?branch=master)
- Integrador responsável pela comunicação com o SigepWeb - http://goo.gl/z8VJjJ.
- Excelente documentação do SigepWeb providenciada pelos Correios: [Manual Logistica Reversa.pdf](manual_logistica_reversa.pdf) :trollface:
- Métodos suportados
-- Solicitação de postagem de reversa (documentação, pág 36)
-- Busca de SRO - ticket (documentação, pág 39)
## Instalação
Adicione ao seu Gemfile:
```ruby
gem 'correios_sigep'
```
E execute:
$ bundle
Ou instale manualmente com:
$ gem install correios_sigep
## Utilizando
### Configurando
Para utilizar a gem, é necessário configurar os campos necessários com base nos dados contrato com os Correios. (O exemplo a seguir são os dados do ambiente de homologação)
```ruby
CorreiosSigep.configure do |config|
config.user = 'empresacws'
config.password = '123456'
config.administrative_code = '17000190'
config.card = '0067599079'
config.service_code = '41076'
end
```
Para utilizar o ambiente de homologação dos correios, adicione essa configuração:
```ruby
config.development = true
```
Se for necessário, é possível adicionar também um proxy.
```ruby
config.proxy = 'http://px.myproxy.com'
```
### Logistica Reversa
#### Solicitar Postagem Reversa
(pg. 36 da documentação)
```ruby
recipient = CorreiosSigep::Models::Recipient.new({
address: 'Endereco',
area_code: 'DDD',
city: 'Cidade',
complement: 'Complemento',
email: 'Email',
name: 'Nome',
neighborhood: 'Bairro',
number: 'Numero',
phone: 'Telefone',
postal_code: 'CEP',
reference: 'Referencia',
state: 'Estado'
})
sender = CorreiosSigep::Models::Sender.new({
address: 'Endereco',
area_code: 'DDD',
city: 'Cidade',
complement: 'Complemento',
email: 'Email',
name: 'Nome',
neighborhood: 'Bairro',
number: 'Numero',
phone: 'Telefone',
postal_code: 'CEP',
reference: 'Referencia',
state: 'Estado'
})
objects = [
CorreiosSigep::Models::Object.new({
item: 'Item',
id: '1',
description: 'Descricao',
num: '',
}),
CorreiosSigep::Models::Object.new({
item: 'Item',
id: '2',
description: 'Descricao',
num: '',
})
]
# Produto: pag 67 da documentação oficial dos correios
product = CorreiosSigep::Models::Product.new({
code: '116600403',
type: '0',
quantity: 1
})
collect = CorreiosSigep::Models::Collect.new({
aditional_service: '10.00',
ag: '5',
ar: '1',
card: '',
checklist: '2',
client_id: '102030',
declared_value: '1000.00',
description: 'Descricao',
number: '',
type: 'A'
}.merge(sender: sender, objects: objects, product: product))
logistic_reverse = CorreiosSigep::Models::LogisticReverse.new(recipient: recipient, collect: collect)
collect_number = CorreiosSigep::LogisticReverse::RequestCollectNumber.new(logistic_reverse).process
```
#### Possíveis erros mapeados
```ruby
TICKET_ALREADY_USED = 195 # NÚMERO DE E-TICKET JÁ UTILIZA
UNAVAILABLE_SERVICE = 210 # SERVIÇO INDISPONÍVEL NO MOMENTO
INEXISTENT_ZIPCODE = 113 # CEP DO DESTINATÁRIO INEXISTENTE
UNAVAILABLE_HOUSE_COLLECT = 111 # COLETA DOMICILIAR NÃO DISPONÍVEL PARA O SERVIÇO SEDEX 10
COLLECT_NOT_ANSWERED_FOR_THE_ZIPCODE = 117 # CEP DO REMETENTE INEXISTENTE
NOT_CONFIGURED_CLIENT = 105 # CLIENTE NÃO CONFIGURADO PARA USAR O SISTEMA
```
## Contributing
1. Fork it ( https://github.com/duduribeiro/correios_sigep/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request