Manual para Integração via Web Services - Correios

[Pages:69]Manual para Integra??o via Web Services

Diretoria de Neg?cios dos Correios ? Departamento de Canais Digitais Revis?o 27/08/2021

SIGEP Web ? Gerenciador de Postagens dos Correios Manual para Integra??o via Web Services

Sum?rio

Introdu??o ...................................................................................................................4 1. Pr?-Requisitos .....................................................................................................4 2. Processo de Integra??o.......................................................................................4 3. Web Services SIGEP Web ..................................................................................6 3.1 Ambiente de Desenvolvimento e Homologa??o ....................................................6 3.2 Ambiente de Produ??o ..........................................................................................6 4. M?todos do Web Services do SIGEP Web .............................................................7 4.1 Disponibilidade do Servi?o entre o CEP da Origem e CEP de Destino.................7 4.2 Servi?os Dispon?veis para o Cart?o ....................................................................10 4.3 Consulta Endere?o via CEP ................................................................................11 4.4 Situa??o do Cart?o de Postagem........................................................................12 4.5 Solicita??o de Faixa de Etiquetas para Postagem ..............................................13 4.6 D?gito Verificador de N?mero da Etiqueta de Postagem .....................................16 4.7 Fechamento de Pr?-lista de Postagem de Objetos .............................................17 4.8 Solicita??o de XML da PLP .................................................................................32 4.9 Solicita??o de Suspens?o de Entrega de Encomenda ao Destinat?rio...............35 ANEXO 01 - R?tulo de Endere?amento: ...................................................................37 ANEXO 02 - Algoritmo Gera??o do d?gito verificador................................................38 ANEXO 03 ? Layout 2D ? Data Matrix ......................................................................39 ANEXO 04 ? Valida??o do XML utilizando o Schema XSD ......................................42 ANEXO 05 - C?digo da Diretoria Regional (tag ) ......................43 ANEXO 06 - C?digo do Servi?o Adicional ................................................................44 ANEXO 07 ? Categoria de servi?os e s?mbolos de encaminhamento.......................48 ANEXO 08 ? C?digo Forma de Pagamento (tag ) ...................49 ANEXO 09 - Exemplo de Tabelas para Armazenamento em Banco de dados ........50 ANEXO 10 ? Voucher de Postagem ou Lista de Postagem e Aviso de RecebimentoAR .............................................................................................................................52 ANEXO 11 - Vis?o do Processo de Integra??o .........................................................54 ANEXO 12 ? Termo De Condi??es De Presta??o De Servi?os De Encomendas Nacionais...................................................................................................................63 ANEXO 13 ? Calculador de pre?os e prazos de encomendas ..................................64

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

2

SIGEP Web ? Gerenciador de Postagens dos Correios Manual para Integra??o via Web Services

Anexo 14 ? Coletar o ciente do cliente para as tags restricao_anac e ciencia_conteudo_proibido ........................................................................................ 65 Anexo 15: Entrega no Vizinho ...................................................................................67 Anexo 16 - Inser??o dos dados de radiofrequ?ncia (RFID).......................................69

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

3

SIGEP Web ? Gerenciador de Postagens dos Correios

Manual para Integra??o via Web Services

Introdu??o

Os Correios disponibilizam gratuitamente, para clientes com contrato, um conjunto de servi?o acess?veis via Web services que possibilita a integra??o dos sistemas dos clientes com o ambiente tecnol?gico dos Correios. Este manual descreve os m?todos Web services da aplica??o SIGEP Web, que propicia aos clientes o gerenciamento de suas postagens, possibilitando:

Organiza??o e registro dos objetos em uma ?nica interface integrada aos Correios; Pesquisa de servi?os dispon?veis no cart?o de postagem; Verifica??o do status do contrato e cart?o de postagem; Antecipa??o do c?digo de registro dos objetos antes mesmo da postagem; Gera??o pr?via de lista de objetos para controle das postagens; Acesso a informa??es, tais como: rastreamento dos objetos, consulta de CEP,

abrang?ncia dos servi?os, pr?via de faturamento em D+1.

1. Pr?-Requisitos

Para fazer integra??o de sistemas com o Web services SIGEP Web, o cliente necessita ter contrato com os Correios. Nesse caso, poder? solicitar ao representante comercial dos Correios a autoriza??o de acesso (usu?rio e senha) para o contrato e cart?o de postagem (mesmo CNPJ).

2. Processo de Integra??o

Na vis?o aqui proposta, o processo de integra??o envolve Correios e Cliente em cinco

etapas:

1. Inicializa??o:

Nesta etapa, primeiramente o sistema do cliente realiza uma consulta para verificar

e/ou validar a situa??o do cart?o e os servi?os dispon?veis. Essa a??o poder? ser

executada, por exemplo, uma vez ao dia; com isso, evita-se que os objetos sejam

encaminhados para um servi?o inexistente no contrato ou ent?o com situa??o

cadastral pendente.

Ap?s a valida??o do situa??o contratual e obten??o dos dados do contrato e do

cart?o, a demanda de etiquetas poder? ser requerida. Essa funcionalidade, "Solicitar

etiquetas", sempre retornar? um range de n?meros de acordo com a quantidade

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

4

SIGEP Web ? Gerenciador de Postagens dos Correios

Manual para Integra??o via Web Services

requisitada. Os n?meros de registros obtidos identificar?o os objetos que ser?o postados nos Correios, devendo ser utilizados para acompanhar o rastreamento. O sistema do cliente dever? gerenciar localmente a reserva de faixas de n?meros de registro das encomendas, que ser?o consumidas por ele ao longo de um per?odo pr?-definido. Essa ? uma recomenda??o de boas pr?ticas de desenvolvimento da solu??o aqui proposta, por?m, n?o h? impedimentos t?cnicos de se fazer a solicita??o do n?mero de registro por pedido. 2. Atendimento Pedido: Contempla os passos m?nimos para prepara??o f?sica das encomendas por parte do cliente. Permite a valida??o de pre?o, prazo, disponibilidade do servi?o para o CEP destino, al?m de selecionar a melhor forma de entrega de acordo com a necessidade. O r?tulo a ser impresso deve seguir o padr?o proposto neste documento, ANEXO 01; 3. Pr?-postagem: Fechamento da Pr?-lista de Postagem ? PLP, dos pedidos anteriormente atendidos. Estes pedidos ser?o consolidados diariamente em uma ?nica lista a ser enviada de forma eletr?nica aos Correios. O retorno ser? um n?mero que identificar? a PLP. Este n?mero ? a chave para o recebimento das encomendas nos Correios a ser disposto no voucher, modelo no ANEXO 10 deste documento. O controle de expedi??o da encomendas ser? por meio do voucher, a ser gerado pelo sistema do cliente; 4. Postagem: Apresenta os passos para a postagem das encomendas nos Correios; 5. Acompanhamento: Esta etapa corresponde ao gerenciamento das encomendas encaminhadas e postadas nos Correios. Al?m de obter o rastreamento da encomenda no fluxo postal at? o momento da sua entrega, ser? poss?vel obter os dados atualizados da aferi??o ecapta??o do atendimento e o valor precificado no sistema de atendimento dos Correios, para cada encomenda. Outra funcionalidade dispon?vel nesta etapa ? a suspens?o da entrega de uma encomenda j? postada. Conforme disposto no ANEXO 12.

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

5

SIGEP Web ? Gerenciador de Postagens dos Correios Manual para Integra??o via Web Services

O fluxo com a vis?o geral do processo de integra??o consta no ANEXO 11 deste documento.

3. Web Services SIGEP Web

Para a integra??o com o Web services SIGEP Web, s?o adotados os padr?es SOAP (Simple Object Access Protocol) e XML (eXtended Markup Language).

3.1 Ambiente de Desenvolvimento e Homologa??o

Ap?s o desenvolvimento, o cliente dever? fazer os testes de integra??o do seu sistema com a plataforma dos Correios. Para essa finalidade, est? dispon?vel um ambiente para desenvolvimento e homologa??o da integra??o do sistema do cliente com o Web services SIGEP Web, onde a interface e dever? ser consultada e configurada no seguinte endere?o: No quadro a seguir, constam as informa??es necess?rias para a autentica??o e testes no ambiente de desenvolvimento e homologa??o.

Usu?rio sigep

Senha n5f9t8

C?digo

Contrato

SE

Administrativo

17000190

9992157880 10

Cart?o

CNPJ

0067599079 34028316000103

*** Para desenvolvimento e homologa??o, os c?digos de servi?os devem ser consultados por meio do m?todo buscaCliente().

Finalizados os testes o cliente deve encaminhar o XML, a PLP e os r?tulos ao respons?vel pelo contrato nos Correios para as respectivas valida??es.

3.2 Ambiente de Produ??o

Para produ??o, dever?o ser utilizados os par?metros do contrato celebrado com os Correios, bem como, os dados de autentica??o do cliente e contrato. Para esse ambiente, a interface do Web services dever? ser consultada e configurada no seguinte endere?o:

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

6

SIGEP Web ? Gerenciador de Postagens dos Correios Manual para Integra??o via Web Services

4. M?todos do Web Services do SIGEP Web

Neste item est?o descritos os m?todos do Web services do SIGEP Web.

Em caso de erro na autentica??o dos m?todos, o cliente deve entrar em contato com o representante comercial dos Correios respons?vel pelo contrato.

Para facilitar a gest?o da informa??o, no ANEXO 09 deste documento, consta uma sugest?o de esquema de tabelas que o cliente poder? implementar para o armazenamento de dados a serem enviados e recebidos dos SIGEP Web.

4.1 Disponibilidade do Servi?o entre o CEP da Origem e CEP de Destino

Por meio desse m?todo, pode ser verificado se um servi?o que n?o possui abrang?ncia nacional est? dispon?vel entre um CEP de Origem e de Destino (Ex: Sedex, PAC, Sedex 10, Sedex 12, Sedex Grandes Formatos e PAC Grandes Formatos).

a) Assinatura do M?todo:

verificaDisponibilidadeServico (codAdministrativo, numeroServico, cepOrigem, cepDestino, usuario, senha)

b) Layout do M?todo:

Campo codAdministrativo

Tipo de Dado String(8)

numeroServico

String(5)

cepOrigem

String (8)

cepDestino usuario

String (8) String

senha

String

Descri??o/Observa??o

Obrigat?rio

C?digo Administrativo do contrato do

Sim

Cliente com os Correios.

C?digos dos servi?os contratados. Ex: Sim

03220, 03298.

CEP de Origem sem h?fen.Exemplo:

Sim

70002900

CEP de Destino sem h?fen

Sim

Login do usu?rio para autentica??o.

Sim

(Fornecido pelo Representante

Comercial dos Correios mediante carta

de solicita??o.)

Senha de autentica??o. (Fornecida

Sim

pelo Representante Comercial dos

Correios mediante carta de solicita??o)

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

7

SIGEP Web ? Gerenciador de Postagens dos Correios Manual para Integra??o via Web Services

c) Retorno do M?todo:

Tag

Tipo de Dado String - "c?digo do erro#motivo"

d) Exemplo:

Consulta de Servi?o entre CEP de Origem e Destino com retorno v?lido.

17000190 04162 05311900 05311900 sigep n5f9t8

Retorno:

0#

Consulta de Servi?o entre CEP de Origem e Destino com retorno inv?lido.*

17000190 04669 05311900 05311900 sigep n5f9t8

Retorno:

008#Servi?o indispon?vel para o trecho informado.

* Correios Web Services.

Diretoria de Neg?cios ? Departamento de Canais Digitais

Revis?o 27/08/2021

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download