Sirb.CepBrasil 1.0.3

Install-Package Sirb.CepBrasil -Version 1.0.3
dotnet add package Sirb.CepBrasil --version 1.0.3
<PackageReference Include="Sirb.CepBrasil" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sirb.CepBrasil --version 1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Sirb.CepBrasil, 1.0.3"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Sirb.CepBrasil as a Cake Addin
#addin nuget:?package=Sirb.CepBrasil&version=1.0.3

// Install Sirb.CepBrasil as a Cake Tool
#tool nuget:?package=Sirb.CepBrasil&version=1.0.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Sirb.CepBrasil

O projeto tem como objetivo viabilizar uma interface para busca de logradouro por CEP.

Os serviços utilizados pelo projeto não é de responsabilidade e/ou mantido pelo mesmo.

Execução do serviço

Os serviços externos utilizados são disponibilizados pelos Correios e ViaCep. Se a busca em ambos os serviços não tenha resulta o serviço irá definir a busca como não sucesso.A implementação desta interface funciona da seguinte forma:

Fluxo Principal

  1. O usuário instancia ICepService. O componente pode receber um objeto do tipo HttpClient ou o mesmo instancia e gerencia a utilização do mesmo;
  2. O usuário informa o CEP para busca;
  3. É efetuado uma validação de parâmetro minimo. (CEP deve conter 8 caracteres numericos);
  4. A interface efetua a busca no serviço dos Correios;
    • Fluxo Alternativo - Logradouro não encontrado
    • Fluxo Alternativo - Falha na busca
  5. A interface retorna retorna o resultado no objeto tipo CepResult.

Fluxo Alternativo

Logradouro não encontrado
  1. Busca no serviço dos Correios não houver um retorno;
  2. A interface efetua a busca no serviço de ViaCep;
    • Fluxo Alternativo - Falha na busca
  3. A interface retorna retorna o resultado no objeto tipo CepResult.
Falha na busca
  1. Toda falha na busca é preenchido a propriedade CepResult.Message com a mensagem da falha;
  2. Caso exista uma exceção na execução esta será inclusa na lista de exceções, CepResult.Exceptions;
  3. A interface retorna retorna o resultado no objeto tipo CepResult.

Composição

CepResult

Success: bool CepContainer: CepContainer Message: string Exceptions: List<Exception>

CepContainer

Uf: string Cidade: string Bairro: string Complemento: string Cep: string

Informações Adicionais

Para informações sobre o serviço dos Correios, visite https://www.correios.com.br/enviar-e-receber/precisa-de-ajuda/ ou https://www.correios.com.br/enviar-e-receber/precisa-de-ajuda/Manual_de_Implementacao_do_Web_Service_SIGEP_WEB.pdf

Para informações sobre ViaCEP, visite https://viacep.com.br/;

Nota

Os demais métodos disponibilizados pelo serviço dos Correios no qual é necessário cadastro de usuário e todo o processo que envolva ou relacione a cadastro de usuário não será disponível nesta interface.

Versão 1.0.2

Limpeza do retorno para remoção de caracteres indesejados.

Versão 1.0.1

Inclusão de compatibilidade com dotnet core 3 e 3.1.

Versão 1.0.0

Disponibilização da interface para a versão dotnet 5.

  • .NETCoreApp 3.0

    • No dependencies.
  • .NETCoreApp 3.1

    • No dependencies.
  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 82 8/10/2021
1.0.2 128 1/24/2021
1.0.1 145 1/23/2021
1.0.0 190 12/13/2020

Inclusão de compatibilidade com dotnet core 3 e 3.1.
Limpeza do retorno para remoção de caracteres indesejados.