Skip to content

Commit

Permalink
Fixed readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cagartner committed May 30, 2019
1 parent 160cb08 commit 5e4a552
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# CorreiosConsulta (Laravel 4/5 Package)

----------------------
Package para consulta de serviços diretamente no site dos correios, sem usar apis de terceiros.
Package para consulta de serviços diretamente no site dos correios, sem usar apis de terceiros.

Baseado nos seguintes repositórios:
Baseado nos seguintes repositórios:
- https://github.com/feliperoberto/correios-cep
- https://github.com/Zizaco/cep-consult

Expand All @@ -12,12 +12,12 @@ Requerimentos:

Para linux: `sudo apt-get install php-soap`

Consultas disponíveis:
Consultas disponíveis:
- CEP
- Frete
- Rastreio

### Instalação
### Instalação

In the `require` key of `composer.json` file add the following

Expand Down Expand Up @@ -53,11 +53,11 @@ Then at the end of `config/app.php` add `'Correios' => 'Cagartner\CorreiosCon
],
```

### Utilização
### Utilização

#### CEP:

Passar apenas o valor do CEP, pode ser formatado, somente números e como string.
Passar apenas o valor do CEP, pode ser formatado, somente números e como string.

```php
<?php
Expand All @@ -80,7 +80,7 @@ Passar apenas o valor do CEP, pode ser formatado, somente n

#### Rastrear

Passar o código de rastreio informado pelos Correios
Passar o código de rastreio informado pelos Correios

```php
<?php
Expand All @@ -101,23 +101,23 @@ Passar o c
(
[data] => 08/06/2015 07:59
[local] => Caraguatatuba/SP
[status] => Saiu para entrega ao destinatário
[status] => Saiu para entrega ao destinat�rio
)

[2] => Array
(
[data] => 03/06/2015 11:48
[local] => CTE SAO JOSE DOS CAMPOS - Sao Jose Dos Campos/SP
[status] => Encaminhado
[encaminhado] => Em trânsito para CDD CARAGUATATUBA - Caraguatatuba/SP
[encaminhado] => Em tr�nsito para CDD CARAGUATATUBA - Caraguatatuba/SP
)

[3] => Array
(
[data] => 02/06/2015 10:00
[local] => AGF DOUTOR JOAO MENDES - Sao Paulo/SP
[status] => Encaminhado
[encaminhado] => Em trânsito para CTE VILA MARIA - Sao Paulo/SP
[encaminhado] => Em tr�nsito para CTE VILA MARIA - Sao Paulo/SP
)

[4] => Array
Expand All @@ -132,31 +132,31 @@ Passar o c

```

#### Cálculo de Frete:
#### Cálculo de Frete:

```php
<?php
$dados = [
'tipo' => 'sedex', // Separar opções por vírgula (,) caso queira consultar mais de um (1) serviço. > Opções: `sedex`, `sedex_a_cobrar`, `sedex_10`, `sedex_hoje`, `pac`, 'pac_contrato', 'sedex_contrato' , 'esedex'
'formato' => 'caixa', // opções: `caixa`, `rolo`, `envelope`
'cep_destino' => '89062086', // Obrigatório
'tipo' => 'sedex', // Separar opções por vírgula (,) caso queira consultar mais de um (1) serviço. > Opções: `sedex`, `sedex_a_cobrar`, `sedex_10`, `sedex_hoje`, `pac`, 'pac_contrato', 'sedex_contrato' , 'esedex'
'formato' => 'caixa', // opções: `caixa`, `rolo`, `envelope`
'cep_destino' => '89062086', // Obrigatório
'cep_origem' => '89062080', // Obrigatorio
//'empresa' => '', // Código da empresa junto aos correios, não obrigatório.
//'senha' => '', // Senha da empresa junto aos correios, não obrigatório.
//'empresa' => '', // Código da empresa junto aos correios, não obrigatório.
//'senha' => '', // Senha da empresa junto aos correios, não obrigatório.
'peso' => '1', // Peso em kilos
'comprimento' => '16', // Em centímetros
'altura' => '11', // Em centímetros
'largura' => '11', // Em centímetros
'diametro' => '0', // Em centímetros, no caso de rolo
// 'mao_propria' => '1', // Não obrigatórios
// 'valor_declarado' => '1', // Não obrigatórios
// 'aviso_recebimento' => '1', // Não obrigatórios
'comprimento' => '16', // Em centímetros
'altura' => '11', // Em centímetros
'largura' => '11', // Em centímetros
'diametro' => '0', // Em centímetros, no caso de rolo
// 'mao_propria' => '1', // Náo obrigatórios
// 'valor_declarado' => '1', // Náo obrigatórios
// 'aviso_recebimento' => '1', // Náo obrigatórios
];

echo Correios::frete($dados);

/*
Retorno para uma única consulta:
Retorno para uma única consulta:
Array
(
[codigo] => 40010
Expand All @@ -176,7 +176,7 @@ Passar o c
*/

/*
Retorno para várias consultas:
Retorno para várias consultas:
Array
(
0 => Array
Expand Down

0 comments on commit 5e4a552

Please sign in to comment.