Bem vindo a documentação geral do Endereço Externo¶

Este portal tem o objetivo de ser a documentação de referência do serviço de Endereço Externo da Prefeitura Municipal de Belo Horizonte, denominado Endereço Externo. Esta documentação é destinada a explicar o negócio do endereço para municípios externos ao município de Belo Horizonte e os limites e alcance do serviço. Tendo uma documentação técnica complementar em Swagger para o consumo do serviço.

O que é o Serviço de Endereço Externo?¶

O serviço consiste em uma API Rest para consulta e gestão do cadastro de endereços no Brasil ou exterior, com exceção de endereços no município de Belo Horizonte, para serem utilizados nos sistemas da Prefeitura de Belo Horizonte.

Por onde começar?¶

Se deseja iniciar o uso do Endereço Externo para um novo sistema pode seguir para os Primeiros Passos.