Testar Comunicação com a API dos Correios


Caminho:
Logística > TMS > Cadastro > Transportadoras

Objetivo

Desenvolver recurso para realizar teste de conexão com API do Correios. Atualmente não há como testar a conexão com a API dos correios via e-Millennium, deste modo, o usuário não consegue validar se a conexão foi realizada corretamente.
Para tornar possível o teste de conexão com os Correios, foi criado um link de comando no cadastro de Transportadoras, que retornará mensagens de erro ou sucesso, quando for acionado pelo operador do sistema.


Este recurso não acompanha a versão do sistema. Para utilizá-lo, solicite aos nossos consultores que forneçam o módulo para instalação. Caso você não consiga fazer a instalação, entre em contato com nosso departamento comercial e solicite a visita de um consultor.


Pré-Requisitos

Instalar o módulo millenium!gf_correios_api.minst. Para informações sobre como fazer a instalação de módulos no e-Millennium acesse o Manual de instalação de módulos no e-Millennium.


Parâmetros

Em Logística > TMS > Transportadoras, na guia Correios API, devem ser preenchidas as credenciais de acesso e os dados referentes ao contrato de serviços, firmado com a empresa:

  • Usuário API
  • Senha API
  • Ambiente API
  • Cartão Postagem
  • Número Contrato
  • CNPJ do Cliente
  • Serviço de Consultas


Caso a conexão com os correios seja realizada por filiais, as credenciais devem ser preenchidas no grid para cada filial e o teste poderá ser realizado por filial.


Entradas

Como funciona a validação?

  1. Primeiramente são validados o Usuário, a Senha e o Cartão Postagem informados para acessar a API;
  2. Após o acesso, são devolvidas informações dizendo quais serviços/funcionalidades da API dos Correios aquele Cartão Postagem pode utilizar:
  3. Na sequência, será checado se os serviços essenciais estão disponíveis para o Cartão Postagem informado.

Lista dos Serviços Essenciais:

  • 36 - Pré-Postagem (PPN)
  • 41 - CEP
  • 35 - Prazo
  • 34 - Preço
  • 566 - Meu Contrato
  • 392 - AR Eletrônico
  • 87 – Rastro




Neste exemplo, podemos ver que não é retornado serviço 392 - AR Eletrônico, que a mensagem que é retornada para usuário.

Após o preenchimento das credenciais de acessos e dos dados contratuais, acione o botão de validação de conexão com a API.


Validações e Saídas

Todas as informações validadas com os correios serão retornadas em forma de mensagem para o operador do sistema.


No caso de validação por filiais, as cores serão aplicadas no grid para cada filial testada.


1.Conexão realizada com sucesso, retornando os serviços contratados, conforme os dados informados. Botão de teste ficará em verde.

2.Conexão não realizada porque ocorreu erro de credenciais de acesso. O botão de teste ficará em vermelho.

3.Conexão realizada com sucesso, porém acusa que algum serviço não está contratado. O botão de teste ficará em amarelo.