From 98b124113237b6e9701c79db81ad4c52d6d4cb24 Mon Sep 17 00:00:00 2001 From: Asafe Ramos Date: Fri, 25 May 2018 22:25:03 -0300 Subject: [PATCH] =?UTF-8?q?Atualiza=C3=A7=C3=A3o=20de=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Documentação de utilização --- README.md | 52 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c8b3c78..6e20b9a 100644 --- a/README.md +++ b/README.md @@ -6,23 +6,35 @@ API construída a partir de parsing da página de rastreio dos Correios. ## Utilização -Adicione o código de rastreio na url: -`http://localhost/correios/RE999999999BR` - -#### Retorno - - [ - { - "date": "12/01/2013", - "hour": "18:35", - "location": "Goiânia - GO", - "label": "Objeto entregue ao destinatário" - }, - { - "date": "12/12/2012", - "hour": "12:12", - "location": "Valparaíso - GO", - "label": "Objeto postado" - } - - ] + +``` +$Correios = new \Baru\Correios\RastreioParser(); +$Correios->setCode('RE999999999BR'); + +//Último evento +$Evento = $Correios->getEventLast(); + +//Lista todos eventos +$Eventos = $Correios->getEventsList(); +``` + +#### Evento +Label +`$evento->getLabel();` +> _Objeto postado_ +--- +Location +`$evento->getLocation();` +> _Goiânia / GO_ +--- +Date +`$evento->getDate();` +> _12/12/2012_ +--- +Hour +`$evento->getHour();` +> _12:12_ +--- +Description +`$evento->getDescription();` +> _de Unidade de Distribuição em SUMARE / SP para Agência dos Correios em SUMARE / SP_