shipping7 / correios-java-sdk Goto Github PK

View Code? Open in Web Editor NEW

33.0 13.0 16.0 609 KB

Correios Java SDK

Home Page: https://shipping7.github.io/correios-java-sdk/

License: MIT License

Java 100.00%

correios correios-rastreio wsdl sdk correios-sdk webservice correios-api correios-sro correios-cep correios-frete

correios-java-sdk's People

Contributors

Stargazers

Watchers

Forkers

waffle-iron gabriellimagomes rachrdm lucazin rreynoud adrianosaaquino rmnresende elo7 allisonerd wdpimenta flaviovantin sp2020jarvan anisioeveris rickdcal nhaz3l alexandrefc

correios-java-sdk's Issues

Renomear classes para Portugues

Goal

Manter o padrão de nomes em portugues

Adicionar timeout a chamada SOAP

[ISSUE-41] - Busca por lista de objetos feita objeto a objeto no WSDL

Quando a busca é feita por mais de um tracking code, a busca é feita um a um batendo no serviço, e existe um método para bater no Correios com todos os tracking codes de uma vez.

Permitir que a solicitação de etiquetas seja feita pelo SDK

Permitir que o usuário do SDK solicite somente 1 etiqueta
Permitir que o usuário do SDK solicite N etiquetas
Permitir que o usuário do sdk consiga retornar o prefixo da etiqueta
Permitir que o usuário do sdk consiga retornar o sufixo da etiqueta
Permitir que o usuário do sdk consiga retornar o número da etiqueta
Permitir que o usuário do sdk consiga retornar a etiqueta completa, já com o dígito verificador

Criar serviço para solicitar números de etiquetas

Adicionar ao SDK um método para trazer etiquetas dado um um tipo de serviço do Correios e número de etiquetas que deseja

Remover o nome "tracking" do sdk para que fique genérico

A ideia é que o SDK possa trabalhar com outros módulos, como:

PLP e Geração de Etiquetas
Estimativa de Fretes
Tracking de Pacotes

Corrigir o status de processamento

Hoje o SDK está fazendo uma conversão errada do status de processamento do Objeto.

Configurar build.gradle para permitir o release no Maven Central

Obs: remover plugins não utilizados no Gradle

Possibilitar busca de estimativa pelo SDK

Trazer os dados de estimativa (preço e prazo) e mapear todos os possíveis erros.

Melhorar os pacotes do SDK

Fix build.gradle com informações do Sonatype

Acontece um erro ao fazer gradle clean pois o arquivo está usando autenticação com o Sonatype que ainda não existe

API de Rastreio lançando exceção quando a busca é de vários objetos

Quando buscar vários objetos, cada um deles pode trazer um erro diferente, então não é correto lançar exceção porque não sabemos se todos estão com erros.

Criar documentação para a busca de Documento PLP

Estrutura documentoPLP desatualizada

A estrutura do modelo de PLP precisa devolver o status do processamento e a cubagem como valor ao invés de texto.

Corrigir solicita postagem com medidas do DocumentoPLP incorretas

Mapear todos os Status e Tipos como Enum

Goal

Mapear todos os Status e Tipos como Enum de acordo com a documentação oficial dos correios.

Melhorar tratamento nos problemas de autenticação na API de postagem

Quando acontece algum problema na chamada da API de postagem, não conseguimos verificar o erro que aconteceu.

Possibilitar o usuário buscar os eventos passando mais dados

Goal

Possibilitar o usuário buscar os eventos passando mais dados.

objetos
resultado
tipo
lingua

Retornar os eventos de um pacote a partir do seu Tracking Code

Objetivo

Retornar os eventos de um pacote a partir do seu Tracking Code. Esta issue é extremamente básica e somente irá cobrir a forma mais simples de retornar a lista de eventos de um pacote.

To Do

Retornar a lista de eventos de um pacote a partir do seu Tracking Code
Converter os objetos dos correios em objetos próprios para o Tracking
Converter os eventos dos correios em objetos próprios para o Tracking
Converter o destino enviado pelos correios em objetos próprios para o Tracking
Permitir que o usuário passe as credenciais necessárias para o uso da API

Observações

Não fazer o tratamento do campo tipo enviado para os correios via API
Não fazer o tratamento do campo resultado enviado para os correios via API
Não fazer o tratamento do campo lingua enviado para os correios via API
Não fazer o tratamento do campo objetos enviado para os correios via API

Busca de detalhes no Rastreio está considerando chamadas anteriores

// código SDK
if (codigosDeRastreio != null && !codigosDeRastreio.isEmpty()) {
	return new SoapCorreiosServicoRastreioApi(credentials, new Rastro().getServicePort(), converter).buscaDetalhesRastreio(codigosDeRastreio, idioma, resultado, LISTA_DE_OBJETOS);
} else if (StringUtils.isNotEmpty(codigoDeRastreio)) {
	return new SoapCorreiosServicoRastreioApi(credentials, new Rastro().getServicePort(), converter).buscaDetalhesRastreio(codigoDeRastreio, idioma, resultado, LISTA_DE_OBJETOS);
}

Como codigosDeRastreio e codigoDeRastreio são atributos da Classe CorreiosRastreioAPI, se ela for construída uma única vez para todas as chamadas, então uma chamada anterior poderia impactar na próxima chamada como nesse caso:

//Caso de uso
DetalhesRastreio detalhesRastreio = correiosApi.buscaPacotesRastreadosPelaListaDeTrackings(Arrays.asList("PO885187892BR","PN210491273BR","DU698173525BR")).comRetornoEmPortugues().somenteUltimoEvento().getDetalhesRastreio();

DetalhesRastreio detalhesRastreio2 = correiosApi.buscaPacoteRastreadoUsandoOCodigo("PN210491273BR").comRetornoEmPortugues().somenteUltimoEvento().getDetalhesRastreio();

Retorno de ObjetoRastreio mesmo aplicando filtro de busca

Ao executar uma busca de ObjetroRastreio filtrando, mesmo assim trás o objeto, exemplo:

Optional<ObjetoRastreio> objetoRastreio = correiosRastreioApi.buscaRastreio()
				.peloCodigoDeRastreio(trackingCode)
				.comRetornoEmPortugues()
				.somenteComUltimoEvento()
				.getDetalhesRastreio()
				.getObjetosRastreio()
				.stream()
				.findAny();

Se o trackingCode existir mesmo sem ultimo evento o retorno não é empty()

Fix build.gradle para não gerar o Javadoc por enquanto

Permitir que seja rodado o comando abaixo sem erros devido ao Javadoc incompleto

$ gradle clean release -Pgradle.useAutomaticVersion=true --info --stacktrace

Implementar a validação de Etiquetas pelo SDK

Adicionar mais informações ao Evento quando o objeto for recebido

Objetivo

Adicionar mais informações ao Evento quando o objeto for recebido, ou seja, quando estiver no status BDE 1, que é Objeto entregue ao destinatário por exemplo.

As seguintes informações também devem ser mostradas no objeto:

Recebedor
Documento

Permitir que usuário busque os eventos de uma lista de tracking codes

Goal

Permitir que usuário busque os eventos de uma lista de tracking codes

Stub de calculador de preço e prazo desatualizado

Por estar desatualizado, o calculador parou de funcionar, tanto para preço e prazo, quanto para prazo.

Permitir que uma PLP seja fechada pelo SDK

Objetivo

Precisamos que o fechamento da PLP seja feito pelo próprio SDK. Para o fechamento precisamos:

Criar o XML que o Correios recebe para o Fechamento da PLP
Id da PLP do Cliente
Faixa de Etiquetas para a PLP

Técnico

O seguinte payload precisa ser enviado para os Correios para o Fechamento de uma PLP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <cli:fechaPlp>
         <!--Optional:-->
         <xml>?</xml>
         <!--Optional:-->
         <idPlpCliente>?</idPlpCliente>
         <!--Optional:-->
         <cartaoPostagem>?</cartaoPostagem>
         <!--Optional:-->
         <faixaEtiquetas>?</faixaEtiquetas>
         <!--Optional:-->
         <usuario>?</usuario>
         <!--Optional:-->
         <senha>?</senha>
      </cli:fechaPlp>
   </soapenv:Body>
</soapenv:Envelope>

Como você pode notar, o Correios recebe o parâmetro xml no corpo do Payload. Esse XML precisa seguir o XSD enviado pelos próprios Correios conforme você pode ver abaixo:

correios_plp.txt

Um exemplo poderia ser:

<?xml version="1.0" encoding="UTF-8"?>
<correioslog>
   <tipo_arquivo>Postagem</tipo_arquivo>
   <versao_arquivo>2.3</versao_arquivo>
   <plp>
      <id_plp />
      <valor_global />
      <mcu_unidade_postagem />
      <nome_unidade_postagem />
      <cartao_postagem>123456789</cartao_postagem>
   </plp>
   <remetente>
      <numero_contrato>123654789</numero_contrato>
      <numero_diretoria>1</numero_diretoria>
      <codigo_administrativo>12365478</codigo_administrativo>
      <nome_remetente><![CDATA[Empresa Ltda]]></nome_remetente>
      <logradouro_remetente><![CDATA[Rua do Remetente]]></logradouro_remetente>
      <numero_remetente>2370</numero_remetente>
      <complemento_remetente><![CDATA[sala 1205,12 andar]]></complemento_remetente>
      <bairro_remetente><![CDATA[Bairro do Remetente]]></bairro_remetente>
      <cep_remetente><![CDATA[70002900]]></cep_remetente>
      <cidade_remetente><![CDATA[Brasilia]]></cidade_remetente>
      <uf_remetente>PR</uf_remetente>
      <telefone_remetente />
      <fax_remetente />
      <email_remetente><![CDATA[[email protected]]]></email_remetente>
   </remetente>
   <forma_pagamento />
   <objeto_postal>
      <numero_etiqueta>PH185560916BR</numero_etiqueta>
      <codigo_objeto_cliente />
      <codigo_servico_postagem>40096</codigo_servico_postagem>
      <cubagem>3,80</cubagem>
      <peso>200</peso>
      <rt1 />
      <rt2 />
      <destinatario>
         <nome_destinatario><![CDATA[Nome Destinatatio]]></nome_destinatario>
         <telefone_destinatario />
         <celular_destinatario />
         <email_destinatario><![CDATA[[email protected]]]></email_destinatario>
         <logradouro_destinatario><![CDATA[Rua do Comprador]]></logradouro_destinatario>
         <complemento_destinatario><![CDATA[Qd: 102 A Lt: 04]]></complemento_destinatario>
         <numero_end_destinatario>1065</numero_end_destinatario>
      </destinatario>
      <nacional>
         <bairro_destinatario><![CDATA[Bairro do Destinatario]]></bairro_destinatario>
         <cidade_destinatario><![CDATA[Goiania]]></cidade_destinatario>
         <uf_destinatario>GO</uf_destinatario>
         <cep_destinatario><![CDATA[70002900]]></cep_destinatario>
         <codigo_usuario_postal />
         <centro_custo_cliente />
         <numero_nota_fiscal />
         <serie_nota_fiscal />
         <valor_nota_fiscal />
         <natureza_nota_fiscal />
         <descricao_objeto />
         <valor_a_cobrar />
      </nacional>
      <servico_adicional>
         <codigo_servico_adicional>025</codigo_servico_adicional>
         <codigo_servico_adicional>019</codigo_servico_adicional>
         <valor_declarado>17</valor_declarado>
      </servico_adicional>
      <dimensao_objeto>
         <tipo_objeto>2</tipo_objeto>
         <dimensao_altura>20</dimensao_altura>
         <dimensao_largura>30.0</dimensao_largura>
         <dimensao_comprimento>38.0</dimensao_comprimento>
         <dimensao_diametro>0</dimensao_diametro>
      </dimensao_objeto>
      <data_postagem_sara />
      <status_processamento>0</status_processamento>
      <numero_comprovante_postagem />
      <valor_cobrado />
   </objeto_postal>
</correioslog>

Possibilitar cancelar um objeto da PLP pelo SDK

Passar a enviar o código do serviço pelo cliente e não pelo SDK

Objetivo

Essa atualização é necessária pois os Correios podem mudar o código do serviço e o SDK pode não acompanhar essa mudança, quebrando o client do SDK.

Fix build.gradle para remover dependência do Javadocjar

Remover dependência do javadoc jar

Ordem dos eventos do serviço de Rastreio está invertida

Criar as classes stub do WSDL de produção dos Correios

To Do

Diferenciar Sandbox e Production via package no primeiro momento

Adiciona UsuarioInstalacao no GerenteDeConta

To Do

Adicionar o atributo UsuarioInstalacao na classe GerenteDeConta
Criar o converter apropriado
Criar os testes

Fix build.gradle removendo configs para build no Maven Central

Migrar Converter de java8 para java6

Goal

Para maior acessibilidade do SDK, migrar para java 1.6

Trocar a impressão do toString para usar MoreObjets do Guava

Método no Evento que saiba se o evento é final.

Permitir retornar os dados do XML de uma PLP a partir do seu id

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <cli:solicitaXmlPlp>
         <!--Optional:-->
         <idPlpMaster>67488374</idPlpMaster>
         <!--Optional:-->
         <usuario>seu usuario</usuario>
         <!--Optional:-->
         <senha>sua senha</senha>
      </cli:solicitaXmlPlp>
   </soapenv:Body>
</soapenv:Envelope>

Melhorar a granularidade das Exceptions retornadas pelos Correios

Objetivo

Melhorar a granularidade a fim de especificar cada erro encontrado. Hoje está retornando absent() ao lançar exception e o cliente não sabe se funcionou ou se não foi encontrado

Mudar de gradle para maven

Objetivo

Mudar de gradle para maven para facilitar o release no Maven Central

Substituir código em Java 8 por Java 6

Goal

O objetivo é permitir que o SDK seja usado por projetos que ainda não estejam com Java 8 e nem Java 7

Gerar as classes de stub de Postagem

Documentação

A Documentação oficial indica como podemos fazer a integração

To Do

Gerar as classes de stub de Postagem
Separar pacote dos stubs de Rastreio e stubs de Postagem

Gerar as classes de Stub baseadas no WSDL dos Correios

Goal

Generate classes based on SOAP Xml used by Correios

Documentation

WSDL document used to track some package based on its code

SOAP Contract:

<definitions xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:tns="http://resource.webservice.correios.com.br/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" name="rastro" targetNamespace="http://resource.webservice.correios.com.br/">
<types>
<xsd:schema>
<xsd:import namespace="http://resource.webservice.correios.com.br/" schemaLocation="Rastro_schema1.xsd"/>
</xsd:schema>
</types>
<message name="buscaEventosLista">
<part name="parameters" element="tns:buscaEventosLista"></part>
</message>
<message name="buscaEventos">
<part name="parameters" element="tns:buscaEventos"></part>
</message>
<message name="ListaEntregaExterna">
<part name="parameters" element="tns:ListaEntregaExterna"></part>
</message>
<message name="buscaEventosListaResponse">
<part name="parameters" element="tns:buscaEventosListaResponse"></part>
</message>
<message name="UnidadesSRO">
<part name="parameters" element="tns:UnidadesSRO"></part>
</message>
<message name="ListaEntregaExternaResponse">
<part name="parameters" element="tns:ListaEntregaExternaResponse"></part>
</message>
<message name="buscaEventosResponse">
<part name="parameters" element="tns:buscaEventosResponse"></part>
</message>
<message name="RastroJson">
<part name="parameters" element="tns:RastroJson"></part>
</message>
<message name="UnidadesSROResponse">
<part name="parameters" element="tns:UnidadesSROResponse"></part>
</message>
<message name="RastroJsonResponse">
<part name="parameters" element="tns:RastroJsonResponse"></part>
</message>
<portType name="Service">
<operation name="buscaEventos">
<input message="tns:buscaEventos" wsam:Action="buscaEventos"></input>
<output message="tns:buscaEventosResponse" wsam:Action="http://resource.webservice.correios.com.br/Service/buscaEventosResponse"></output>
</operation>
<operation name="buscaEventosLista">
<input message="tns:buscaEventosLista" wsam:Action="buscaEventosLista"></input>
<output message="tns:buscaEventosListaResponse" wsam:Action="http://resource.webservice.correios.com.br/Service/buscaEventosListaResponse"></output>
</operation>
<operation name="RastroJson">
<input message="tns:RastroJson" wsam:Action="RastroJson"></input>
<output message="tns:RastroJsonResponse" wsam:Action="http://resource.webservice.correios.com.br/Service/RastroJsonResponse"></output>
</operation>
<operation name="ListaEntregaExterna">
<input message="tns:ListaEntregaExterna" wsam:Action="ListaEntregaExterna"></input>
<output message="tns:ListaEntregaExternaResponse" wsam:Action="http://resource.webservice.correios.com.br/Service/ListaEntregaExternaResponse"></output>
</operation>
<operation name="UnidadesSRO">
<input message="tns:UnidadesSRO" wsam:Action="UnidadesSRO"></input>
<output message="tns:UnidadesSROResponse" wsam:Action="http://resource.webservice.correios.com.br/Service/UnidadesSROResponse"></output>
</operation>
</portType>
<binding name="ServicePortBinding" type="tns:Service">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="buscaEventos">
<soap:operation soapAction="buscaEventos"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
<operation name="buscaEventosLista">
<soap:operation soapAction="buscaEventosLista"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
<operation name="RastroJson">
<soap:operation soapAction="RastroJson"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
<operation name="ListaEntregaExterna">
<soap:operation soapAction="ListaEntregaExterna"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
<operation name="UnidadesSRO">
<soap:operation soapAction="UnidadesSRO"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
</binding>
<service name="rastro">
<port name="ServicePort" binding="tns:ServicePortBinding">
<soap:address location="http://webservice.correios.com.br:80/service/rastro"/>
</port>
</service>
</definitions>

Configurar build.gradle para permitir deploy no Sonatype

Goal

Configurar build.gradle para permitir deploy no Sonatype e possivelmente no Maven Central em seguida

To Do

Criar conta no Jira
Pedir credenciais para o Sonatype através de ticket
Modificar o build.gradle para permitir a geração do pom.xml necessário para o release

Permitir que seja feita uma Busca por Cliente

To Do

A busca por cliente nos correios leva em consideração o seguinte XML SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cli="http://cliente.bean.master.sigep.bsb.correios.com.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <cli:buscaCliente>
         <!--Optional:-->
         <idContrato>?</idContrato>
         <!--Optional:-->
         <idCartaoPostagem>?</idCartaoPostagem>
         <!--Optional:-->
         <usuario>?</usuario>
         <!--Optional:-->
         <senha>?</senha>
      </cli:buscaCliente>
   </soapenv:Body>
</soapenv:Envelope>

O SDK deve permitir que seja feita uma busca pelo cliente levando em consideração os parâmetros acima.

Documentação da página oficial

A documentação na página oficial do SDK sugere o exemplo:

CorreiosCredentials credentials = new CorreiosCredentials("username", "password");

Porém o correto seria:

CorreiosCredenciais credenciais = new CorreiosCredenciais("username", "password");

Estou usando a versão 0.0.28-BETA.

Atualizar o README com a funcionalidade de solicitação de Etiqueta

Refatorar CorreiosRastreioApi para quando usar o ultimo Evento, retornar apenas um pacote

Builder com metodo:

CorreiosRastreioApi.CorreiosRastreioComIdioma.CorreiosRastreioComTipoDeIdentificador.somenteUltimoEvento()

deve retornar somente a opcao getPacoteTracker()

Refatorar a busca de Documento de PLPs, usando a nova forma de DSL

Obs: A nova forma já foi utilizada na solicitação de Etiquetas

Adiciona valores de estimativa como BigDecimal

Adiciona BigDecimal como resposta às seguintes informações: valorServicoAvisoDeRecebimento, valorServicoMaoPropria, valorSeguro, valor e valorSemAdicionais.

shipping7 / correios-java-sdk Goto Github PK

correios-java-sdk's People

Contributors

Stargazers

Watchers

Forkers

correios-java-sdk's Issues

Goal

Goal

Goal

Objetivo

To Do

Observações

Objetivo

Goal

Objetivo

Técnico

Objetivo

To Do

To Do

Goal

Objetivo

Objetivo

Goal

Documentação

To Do

Goal

Documentation

Goal

To Do

To Do

Recommend Projects

Recommend Topics

Recommend Org