Sigep Web

About

This gem provide a easy way to integrate an application to Correios Sigep Web API, all features is based on this API documentation http://goo.gl/UglwTj

Getting started

You can add it to your Gemfile with:

gem 'sigep_web'

or in your console:

gem install sigep_web

Configuration

If you are using Rails put this in your environments configuration files:

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.

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.

{ :success => true, :response => true }

Search Client

This method return the available services of specific post card

SigepWeb.search_client(id_contract: "0000000000", id_post_card: "0000000000")

The method will return something like this

{
  :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

SigepWeb.zip_query(zip: "70002900")

This method will return a hash like this

{
  :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

SigepWeb.request_labels(receiver_type: "C", identifier: "00000000000000", id_service: "104625", qt_labels: 1)