Guia técnico para implementação do Rastreamento de...

Sistema de Rastreamento de Objetos - SRO

20 de maro de 2014 1

Guia tcnico para implementao do Rastreamento de Objetos via XML Verso 1.7 20 de maro de 2014

Para automatizar o processo de retorno de informaes sobre o rastreamento de objetos, o cliente pode conectar-se ao servidor do Sistema de Rastreamento de Objetos SRO e obter detalhes (rastros) dos objetos postados fazendo uso do padro XML (eXtensible Markup Language) para intercmbio das informaes. Cada consulta ao sistema fornece informaes sobre o rastreamento de at 50 objetos por conexo, sem limites de conexes. O Cliente dever informar os nmeros dos objetos a rastrear atravs de uma conexo HTTP (HyperText Transfer Protocol), acessando o endereo abaixo para processamento do formulrio, via mtodo POST:

http://websro.correios.com.br/sro_bin/sroii_xml.eventos

O retorno da solicitao, provido pelo servidor SRO da ECT, ser no formato XML, conforme descrio a seguir. Conectando o servidor da ECT Para ter acesso a este servio, o cliente dever: 1. Solicitar junto rea comercial da ECT a disponibilidade do servio; 2. Receber, da rea comercial, a autorizao para execuo do aplicativo, juntamente com uma identificao de usurio e senha de conexo; 3. Implementar, em seus sistemas, as funcionalidades de conexo com o servidor SRO. Cada consulta ao servidor SRO dever informar, obrigatoriamente:

Campo Descrio Valores

Usuario Identificao do cliente. Informado pela rea comercial dos Correios na ativao do servio. Este campo diferencia letras maisculas e minsculas (case-sensitive).

Senha Senha do cliente. Informado pela rea comercial dos Correios na ativao do servio. Este campo diferencia letras maisculas e minsculas (case-sensitive).

Tipo

Definio de como a lista de identificadores de objetos dever ser interpretada pelo servidor SRO.

L: lista de objetos. O servidor far a consulta individual de cada identificador informado; F: intervalo de objetos. O servidor far a consulta sequencial do primeiro ao ltimo objeto informado, no sendo necessrio informar os valores intermedirios.

Resultado

Delimitao do escopo da resposta a ser dada consulta do rastreamento de cada objeto.

T: sero retornados todos os eventos do objeto; U: ser retornado apenas o ltimo evento do objeto.

Objeto Lista de objetos a pesquisar.

Identificadores listados um aps o outro, sem espaos ou outro smbolo separador. Ex: SQ458226057BRRA132678652BR



Abaixo esto as regras para formao da lista de objetos a pesquisar:

1. Todos os identificadores objetos devero ter o formato padro de 13 (treze) posies. Sendo duas letras para identificao do servio, 8 (oito) caracteres numricos, 1 (um) dgito verificador e duas letras finais para identificao do pas.

2. Estes identificadores so informados pelos Correios na postagem da encomenda.

Ex: SQ458226057BR

3. No poder haver espaos em branco, ou outros caracteres separadores, entre um objeto e outro. Exemplo: para a pesquisa de 50 objetos ser criada uma string de 650 caracteres (13 x 50).

Retorno das informaes As informaes sero retornadas numa mensagem XML conforme o padro abaixo:

Observaes: Os tipos e os status dos eventos so descritos no Anexo 1 deste manual, bem como sugestes de

aes a ser tomadas pelo cliente; Os dados do recebedor s sero apresentados para os eventos de entrega (tipo=BDE status=01). Pode

haver casos em que estes dados no existam e, portanto, no sero exibidos. Para o evento tipo=BDE status=11, poder, caso exista, ser exibido o campo comentrio;

Para evitar uma quantidade excessiva de pesquisa, o cliente dever registrar, no seu banco de dados, todos os objetos que tiveram seu rastreamento concludo. Para isso, indicamos que todos os objetos que forem retornados com o evento tipo BDE, BDI e BDR com status 01 esto com o rastro concludo. No ser mais necessrio envi-los para novas consultas.

O cliente poder optar por gravar, na sua base de dados, todo o retorno relativo ao objeto rastreado e/ou apenas alguns dos eventos. Por exemplo: somente a entrega.

Elemento Pai Elemento Filho Descrio Versao Verso do SRO XML

Qtd Quantidade de objetos consultados

TipoPesquisa Lista ou intervalo de objetos

TipoResultado ltimo evento ou todos os eventos

Objeto Numero Nmero do objeto enviado

Evento

Tipo Tipo do evento de retorno (vide lista a seguir)

Status Status do evento de retorno

Data Data do evento

Hora Hora do evento

Descrio Descrio do evento

Comentrio Um comentrio adicional sobre o evento

Local Local onde ocorreu o evento

Cdigo CEP da unidade ECT

Cidade Cidade onde ocorreu o evento

Uf Unidade da Federao



Abaixo est um exemplo de uma mensagem XML de retorno:

1.0 2 Lista de Objetos Todos os eventos

SQ458226057BR

BDE 01 05/07/2004 11:56 Entregue CDD ALVORADA 94800971 ALVORADA RS

OEC 01 05/07/2004 09:04 Saiu para entrega CDD ALVORADA 94800971 ALVORADA RS

Testes Para apoiar o cliente em testes de conexo, fornecemos abaixo um simples cdigo HTML. Este cdigo poder ser digitado e gravado num arquivo de nome sro_xml.html. Aps a gravao do arquivo em qualquer pasta, basta ao clicar duas vezes no nome do arquivo e em seguida no boto Ok. ATENO: o usurio de teste s poder pesquisar 2 (dois) objetos.

SRO - Pesquisa Objetos via XML

Outros exemplos esto disponveis no Anexo 2 deste manual.



Anexo I Lista de status de eventos A maior parte dos eventos informativa e no necessita de aes especficas por parte do cliente. Os eventos relacionados etapa final da entrega so os mais relevantes e so destacados na lista completa de eventos abaixo. A ltima coluna sugere o que apresentar ao usurio do site, seja ele destinatrio ou remetente. Estas mensagens so compatveis com as informaes exibidas no rastreamento de objetos no site dos Correios. Tipos Status Descrio Detalhe O que o cliente deve fazer

BDE BDI BDR

0 Objeto entregue ao destinatrio

Recebido por: Finalizar a entrega. No mais necessrio prosseguir com o acompanhamento.

BDE BDI BDR

1 Objeto entregue ao destinatrio

Recebido por: Finalizar a entrega. No mais necessrio prosseguir com o acompanhamento.

BDE BDI BDR

2 A entrega no pode ser efetuada - Carteiro no atendido

Aguarde! Objeto estar disponvel para retirada na unidade a ser informada.

Acompanhar. O interessado dever buscar o objeto em uma Unidade dos Correios.

BDE BDI BDR

3 Remetente no retirou objeto na Unidade dos Correios

Objeto em anlise de destinao

Acompanhar. O interessado no buscou o objeto na unidade dos Correios durante o perodo de guarda.

BDE BDI BDR

4 A entrega no pode ser efetuada - Cliente recusou-se a receber

Objeto ser devolvido ao remetente

Acompanhar o retorno do objeto ao remetente.

BDE BDI BDR

5 A entrega no pode ser efetuada



BDE BDI BDR

6 A entrega no pode ser efetuada - Cliente desconhecido no local



BDE BDI BDR

7 A entrega no pode ser efetuada - Endereo incorreto

Objeto sujeito a atraso na entrega ou a devoluo ao remetente

Acompanhar

BDE BDI BDR




BDE BDI BDR

9 Objeto no localizado Favor entrar em contato com os Correios.

Acionar atendimento dos Correios.

BDE BDI BDR

10 A entrega no pode ser efetuada - Cliente mudou-se



BDE BDI BDR

12 Remetente no retirou objeto na Unidade dos Correios



BDE BDI BDR




BDE 20 A entrega no pode ser Ser realizada nova tentativa Acompanhar



Tipos Status Descrio Detalhe O que o cliente deve fazer

BDI BDR

efetuada - Carteiro no atendido

de entrega

BDE BDI BDR

21 A entrega no pode ser efetuada - Carteiro no atendido



BDE BDI BDR

22 Objeto devolvido aos Correios

Acompanhar

BDE BDI BDR

23 Objeto devolvido ao remetente

Recebido por: Acompanhar

BDE BDI BDR

24 Objeto disponvel para retirada em Caixa Postal

Acompanhar

BDE BDI BDR

25 A entrega no pode ser efetuada - Empresa sem expediente

A entrega dever ocorrer no prximo dia til

Acompanhar

BDE BDI BDR

26 Destinatrio no retirou objeto na Unidade dos Correios



BDE BDI BDR

28 Objeto e/ou contedo avariado

Favor entrar em contato com os Correios.


BDE BDI BDR

32 Objeto com data de entrega agendada

Acompanhar

BDE BDI BDR

33 A entrega no pode ser efetuada - Destinatrio no apresentou documento exigido



BDE BDI BDR

34 A entrega no pode ser efetuada - Logradouro com numerao irregular


Acompanhar

BDE BDI BDR

35 Coleta ou entrega de objeto no efetuada

Ser realizada nova tentativa de coleta ou entrega

Acompanhar

BDE BDI BDR

36 Coleta ou entrega de objeto no efetuada



BDE BDI BDR

37 Objeto e/ou contedo avariado por acidente com veculo



BDE BDI BDR

38 Objeto endereado empresa falida

Objeto ser encaminhado para entrega ao administrador judicial

Acompanhar

BDE BDI BDR

40 A importao do objeto/contedo no foi autorizada pelos rgos fiscalizadores






BDE BDI BDR

41 A entrega do objeto est condicionada composio do lote

Acompanhar

BDE BDI BDR

42 Lote de objetos incompleto Objeto ser devolvido ao remetente


BDE BDI BDR

43 Objeto apreendido por rgo de fiscalizao ou outro rgo anuente



BDE BDI BDR

45 Objeto recebido na unidade de distribuio

Entrega prevista para o prximo dia til

Acompanhar

BDE BDI BDR

46 Tentativa de entrega no efetuada

Entrega prevista para o prximo dia til

Acompanhar

BDE BDI BDR

47 Sada para entrega cancelada

Ser efetuado novo lanamento para entrega

Acompanhar

BDE BDI BDR

48 Retirada em Unidade dos Correios no autorizada pelo remetente



BDE BDI BDR

49 As dimenses do objeto impossibilitam o tratamento e a entrega



BDE BDI BDR

50 Objeto roubado Favor entrar em contato com os Correios.


BDE BDI BDR



BDE BDI BDR



BDE BDI BDR

53 Objeto reimpresso e reenviado

Acompanhar

BDE BDI BDR

54 Para recebimento do objeto, necessrio o pagamento do ICMS Importao

Acompanhar. O interessado dever pagar o imposto devido para retirar o objeto em uma Unidade dos Correios.

BDE BDI BDR

55 Solicitada reviso do tributo estabelecido

Acompanhar

BDE BDI

56 Declarao aduaneira ausente ou incorreta






BDR

BDE BDI BDR

57 Reviso de tributo concluda - Objeto liberado

Acompanhar

BDE BDI BDR

58 Reviso de tributo concluda - Tributo alterado

O valor do tributo pode ter aumentado ou diminudo

Acompanhar

BDE BDI BDR

59 Reviso de tributo concluda - Tributo mantido

Poder haver incidncia de juros e multa.

Acompanhar

BDE BDI BDR

66 rea com distribuio sujeita a prazo diferenciado

Restrio de entrega domiciliar temporria

Acompanhar

BDE BDI BDR

69 Objeto com atraso na entrega

Acompanhar

BLQ 1 Entrega de objeto bloqueada a pedido do remetente


Acompanhar

CD 0 Objeto recebido na Unidade dos Correios

Acompanhar


Acompanhar


Acompanhar


Acompanhar

CMT 0 Objeto recebido na Unidade dos Correios

Acompanhar

CO 1 Objeto coletado Acompanhar

CUN 0 Objeto recebido na Unidade dos Correios

Acompanhar

CUN 1 Objeto recebido na Unidade dos Correios

Acompanhar

DO 0 Objeto encaminhado para Acompanhar



EST 1 Favor desconsiderar a informao anterior

Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar




FC 1 Objeto ser devolvido por solicitao do remetente


FC 2 Objeto com data de entrega agendada

Acompanhar

FC 3 Objeto mal encaminhado Encaminhamento a ser corrigido.

Acompanhar

FC 4 A entrega no pode ser efetuada - Endereo incorreto


Acompanhar

FC 5 Objeto devolvido aos Correios

Acompanhar

FC 7 A entrega no pode ser efetuada - Empresa sem expediente

A entrega dever ocorrer no prximo dia til

Acompanhar

IDC 1 Objeto no localizado Houve indenizao dos valores correspondentes

Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar


Acompanhar

LDE 9 Objeto saiu para entrega ao remetente

Acompanhar

LDI 0 Objeto aguardando retirada no endereo indicado

Endereo: Acompanhar. O interessado dever buscar o objeto em uma Unidade dos Correios.



LDI 2 Objeto disponvel para retirada em Caixa Postal






OEC 0 Objeto saiu para entrega ao destinatrio


PAR 15 Objeto recebido em

Acompanhar

PAR 16 Objeto recebido no Brasil Objeto sujeito fiscalizao e atraso na entrega

Acompanhar




PAR 17 Objeto liberado pela alfndega

Acompanhar

PAR 18 Objeto recebido na unidade de exportao

Acompanhar

PMT 1 Objeto encaminhado para Acompanhar

PO 0 Objeto postado Acompanhar

PO 1 Objeto postado Acompanhar

PO 9 Objeto postado aps o horrio limite da agncia

Objeto sujeito a encaminhamento no prximo dia til

Acompanhar

RO 0 Objeto encaminhado para Acompanhar

RO 1 Objeto encaminhado para Acompanhar

TRI 0 Objeto encaminhado para Acompanhar

Os tipos dos eventos correspondem a mecanismos de controle interno dos Correios, sendo desnecessrio ao cliente o entendimento de seus detalhes: Tipos Significado

BDE Baixa de distribuio externa

BDI Baixa de distribuio interna

BDR Baixa corretiva

BLQ Bloqueio de objetos

CAR Conferncia de lista de registro

CD Conferncia de nota de despacho

CMT Chegada de um meio de transporte

CO Coleta de objetos

CUN Conferncia de lista de registro

DO Expedio de nota de despacho

EST Estorno

FC Funo complementar

IDC Indenizao de objetos

LDI Lista de distribuio interna

LDE Lista de distribuio externa

OEC Lista de Objetos Entregues ao Carteiro

PAR Conferncia Unidade Internacional

PMT Partida Meio de Transporte

PO Postagem (exceo)

RO Expedio de Lista de Registro

TRI Triagem


20 de maro de 2014 10

Anexo II Exemplos de consultas Qualquer linguagem de desenvolvimento com suporte a XML poder ser usada para busca e traduo do retorno do rastreamento em XML. Exemplo de conexo com VBScript 'Cria objeto de conexo dim httpOb set httpOb = Server.CreateObject("Microsoft.XMLHTTP") 'Abre conexo com o servidor do SRO especificando o arquivo de entrada httpOb.Open "POST","http://websro.correios.com.br/sro_bin/sroii_xml.eventos", false, "", "" 'Se a conexo for aberta, estabelece o cabealho e envia o cdigo dos objetos httpOb.setRequestHeader "Content-Type","application/x-www-form-urlencoded" httpOb.Send "usuario=ECT&senha=SRO&tipo=L&Resultado=U& objetos=SQ458226057BRRA132678652BRSX142052885BR 'Armazena a resposta do servidor xml_out = httpOb.responseText 'Esvazia o objeto de conexo set httpObj = nothing 'Fim da conexo Exemplo de uma conexo com JAVAScript // Cria objeto de conexo var httpOb = Server.CreateObject("Microsoft.XMLHTTP"); var URL = http://websro.correios.com.br/sro_bin/sroii_xml.eventos; // Abre conexo com o servidor do SRO especificando o arquivo de entrada httpOb.Open("POST",URL, false, "", ""); //Se a conexo for aberta, estabelece o cabealho e envia o cdigo dos objetos httpOb.setRequestHeader("Content-Type","application/x-www-form-urlencoded"); httpOb.Send "usuario=ECT&senha=SRO&tipo=L&Resultado=T& objetos=SQ458226057BRRA132678652BRSX142052885BR //Armazena a resposta do servidor xml_out = httpOb.responseWrite;


20 de maro de 2014 11

Exemplo de uma conexo via aplicao Visual Basic Para este tipo de conexo poder ser usado a OCX (Active Object Component) Inet ou o prprio objeto DOM fornecido por Microsoft XML 3.0. Dim objetos as string Objetos = SQ458226057BRRA132678652BRSX142052885BR relao de objetos Inet1.Execute "http://websro.correios.com.br/sro_bin/sroii_xml.eventos", _

"POST", _ "usuario=ECT&senha=SRO&tipo=L&resultado=T&objetos=" & objetos, _ "Content-Type: application/x-www-form-urlencoded"

While Inet1.StillExecuting DoEvents

Wend Private Sub Inet1_StateChanged(ByVal State As Integer)

Dim pToken As String Dim pResp As String If State = icResponseCompleted Then

Do pToken = Inet1.GetChunk(1024, icString) pResp = pResp & pToken

Loop While Len(pToken) 0 Call AnalisaResposta(pResp) os dados de rastreamento viro em pResp

End If End Sub Exemplo de uma conexo em JAVA import java.io.*; import java.net.*; import java.sql.*; public class GravaXML {

public void SaveXML(String mfile){ try {

File fileXML = new File(mfile); String xmlin = MontaBusca(); URL url = new URL("http://websro.correios.com.br/sro_bin/sroii_xml.eventos "); URLConnection connection = url.openConnection(); connection.setDoOutput(true); connection.setUseCaches(false); connection.setRequestProperty("Content-Type","application/x-www-form-urlencoded") connection.setAllowUserInteraction(false); PrintStream outStream = new PrintStream(connection.getOutputStream()); outStream.println("usuario=ECT&senha=SRO&tipo=L&resultado=T&objetos=" + xmlin); outStream.close(); DataInputStream inStream = new DataInputStream(connection.getInputStream()); String inputLine; FileWriter f = new FileWriter(fileXML); while ((inputLine = inStream.readLine()) != null) {

f.write(inputLine); } f.close(); inStream.close();

} catch (MalformedURLException e) { e.printStackTrace();

} catch (IOException e) { e.printStackTrace();

} } private String MontaBusca(){

String Objetos = ; // dever ser feito uma pesquisa no banco de dados do Cliente e preencher a string // objetos com o nmero dos objetos a serem pesquisados. return Objetos;

} }

Guia técnico para implementação do Rastreamento de...

Documents

Transcript of Guia técnico para implementação do Rastreamento de...