README.md
# Sigep Web
[](https://badge.fury.io/rb/sigep_web)
[](https://coveralls.io/github/marceloperini/sigep_web?branch=master)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=DWFWT6N2YCZTG)
## About
This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this [API documentation](https://www2.correios.com.br/sistemas/encomendas/sigepweb/doc/Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf)
## Getting started
You can add it to your Gemfile with:
``` ruby
gem 'sigep_web'
```
or in your console:
``` ruby
gem install sigep_web
```
### Configuration
If you are using Rails put this in your environments configuration files:
``` ruby
SigepWeb.configure do |config|
config.user = 'YOUR_USER'
config.password = 'YOUR_PASSWORD'
config.administrative_code = 'YOUR_ADM_CODE'
config.card = 'YOUR_CARD_NUMBER'
config.contract = 'YOUR_CONTRACT_NUMBER'
end
```
### How It Works
#### Consulting service availability
This check whether a particular service is available from source zip code to target zip code.
``` ruby
SigepWeb.service_availability(service_number: '40215',
source_zip: '70002900',
target_zip: '74730490')
```
This method will return a hash like this if has a success response, the second attribute indicate if a particular service is available.
``` ruby
{ success: true, response: true }
```
#### Search Client
This method return the available services of specific post card
``` ruby
SigepWeb.search_client(id_contract: "0000000000",
id_post_card: "0000000000")
```
The method will return something like this
``` ruby
{
success: true,
response: {
cnpj: '0000000000',
contratos: {
cartoes_postage: {
codigo_administrativo: '000000000',
numero: '000000000',
servicos: [
{
codigo: '40096',
descricao: 'SEDEX - CONTRATO',
id: '104625'
},
...
]
}
}
}
}
```
#### Zip Query
This method return the address based on zip code
``` ruby
SigepWeb.zip_query(zip: "70002900")
```
This method will return a hash like this
``` ruby
{
success: true,
response: {
bairro: 'Asa Norte',
cep: '70002900',
cidade: 'Brasília',
complemento: nil,
complemento2: nil,
end: 'SBN Quadra 1 Bloco A',
id: '0',
uf: 'DF'
}
}
```
#### Request Labels For Posts
Return one label or a range of labels to use for posts
``` ruby
SigepWeb.request_labels(receiver_type: 'C', identifier: '00000000000000',
id_service: '104625', qt_labels: 1)
```
return:
```ruby
{ success: true, response: ['DL61145929 BR'] }
```
#### Request verifying digit
to generate the verifying digit for a specific label use:
```ruby
SigepWeb.generate_labels_digit_verifier(labels: 'DL61145929 BR')
```
return:
```ruby
{ success: true, response: 6 }
```
#### Create receiver structure
use the _SigepWeb::Models::Receiver_ to create receiver structure:
```ruby
SigepWeb::Models::Receiver.new(name: 'Josefina', email: 'josefina@foo.com',
number: '10', address: 'Rua X',
complement: 'Perto da rua X+1',
neighborhood: 'Bairro X-1',
city: 'Cidade Y', uf: 'SP', amount: '0,0',
cep: '04105-070')
```
#### Create post object dimensions
use the _SigepWeb::Models::DimensionObject_ to create object dimensions:
```ruby
SigepWeb::Models::DimensionObject.new(object_type: '002', height: '20',
width: '30', length: '38',
diameter: '0')
```
* object_type: use 001 to letter envelope, 002 to package/ box and 003 to roll/ cylinder
#### Create post object
use the _SigepWeb::Models::PostalObject_ to create post object:
```ruby
SigepWeb::Models::PostalObject.new(label_number: 'DL611459296BR',
postage_code_service: '40096',
cubage: 0.0, weight: '400',
receiver: receiver,
dimension_object: dimension_object,
processing_status: '0')
```
* label_number: tracking code with verifying digit
* postage_code: service code to use (SEDEX, PAC, etc.), for this example was used SEDEX, to get all available codes use _SigepWeb.search_client_
* receiver: object instance of _SigepWeb::Models::Receiver_ class
* dimension_object: object instance of _SigepWeb::Models::DimensionObject_ class
* processing_status: default value is '0'
#### Create sender
```ruby
SigepWeb::Models::Sender.new(directorship_number: '16', name: 'Loja X',
address: 'Rua X', number: '10',
complement: 'perto da rua X+1',
neighborhood: 'Bairro Y',
zip_code: '7400000', city: 'Goiânia',
uf: 'GO', email: 'contato@loja_x.com.br',
postal_objects: postal_objects)
```
#### Submit the plp
```ruby
SigepWeb.request_plp_services(plp: sender, id_plp_client: 00_000_000,
labels: labels)
```