Informações
Correios dispõe de uma nova API de cotação de frete, onde o viés tecnológico também fora alterado. Esta nova API denominamos na plataforma de versão REST V1, pois ainda dispomos da integração na versão WebService.
- Com esta nova integração teremos os seguintes benefícios:
- Oferecer ao cliente final o meio de entrega mais conhecido do Brasil em um serviço ainda mais estável;
- Ganho em tecnologia (REST);
- Desacoplamos o modo que realizamos cotação;
- Nova API nos possibilita evoluções em outras frentes que demandam conhecimento prévio de localidade;
- Versionamento de APIs;
- Melhor ponto de contato para tratativas de parcerias e problemas.
Warning
Na plataforma continuaremos com a versão WebService dos Correios, mas salientamos a importância de migração para a nova versão dos, pois o suporte por parte do nosso parceiro em algum momento cessará, e caso haja dificuldades não teremos total cobertura, tendo em vista que o foco é trabalharmos sempre com novas tecnologias.
Observação Geral
A integração com a API Rest dos Correios encontra-se presente nos dois motores logísticos da plataforma, que são: EzDelivery e OmniCommerce.
[Configurações EzDelivery]
1. Dentro do seu Painel Administrativo (Admin), acesse "Configs" e clique em "Meios de Entrega".
2. Uma vez dentro do gerenciador de meios de entrega, clique em "Adicionar meio de entrega".
3. Na Aba, Forma de Entrega, selecione na propriedade Tipo a opção Transportadora, e na propriedade Transportadora a opção Correios, conforme abaixo:
4. Na propriedade Método de entrega deve ser selecionado o respectivo contrato que fora firmado com os correios.
5. Os demais preenchimentos nesta aba ficarão de acordo com as regras de negócios de cada cliente.
6. Próximo passo é inserir as credenciais de autenticação da nova API que fica localizado na aba Configurações do Gateway.
7. O que determinará se neste meio de entrega será utilizada a integração com a API Rest é a propriedade Correios.Rest.UseRestClient. Deverá ser inserido o valor True para ativação da integração.
8. Atentando-se a imagem acima, todas as propriedades que contenham em parte de sua nomenclatura a palavra Rest deverá ser preenchida com os respectivos dados conforme instruído em cada label.
9. Abaixo, dicionário de dados de cada propriedade a ser configurada:
| Propriedade | Descrição |
| Correios.Rest.ContractNumber | Número do Contrato fornecido pelos Correios, obrigatório para a utilização da nova API (REST). |
| Correios.Rest.Environment | Especifica o ambiente da API dos Correios a ser utilizado (homologação/produção). Informar HOM ou PRD |
| Correios.Rest.UseRestClient | Determina se deve utilizar a nova API dos Correios (REST). Informar True ou False |
| Correios.Rest.UserName | Nome de usuário para acesso à nova API dos Correios (REST) |
| Correios.Rest.UserPassword | Senha para acesso à nova API dos Correios (REST) |
| Correios.UseRetailFallback | Utilizar tabelas de varejo dos correios em caso de contingência. True: Sim False: Não |
[Configurações OmniCommerce]
- Dentro do seu painel administrativo (admin), acesse Configs e clique em Meios de Entrega