Sirb.CepBrasil 1.0.3

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.0 This package targets .NET Core 3.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Sirb.CepBrasil --version 1.0.3                

                    
                

            
NuGet\Install-Package Sirb.CepBrasil -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<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                

                    
                

            
#r "nuget: Sirb.CepBrasil, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. 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

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 is compatible.  netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .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.3.1 172 1/2/2024
1.3.0 183 11/26/2023
1.2.0 337 12/29/2022
1.1.2 394 10/14/2022
1.1.1 389 9/4/2022
1.1.0 430 7/30/2022
1.0.4 373 10/9/2022
1.0.3 380 8/10/2021
1.0.2 376 1/24/2021
1.0.1 402 1/23/2021
1.0.0 439 12/13/2020

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