Primeiros Passos¶

O Endereço Externo consiste em um web service no padrão REST, com sistema de autenticação no padrão OpenID. A autenticação é fornecida pelo serviço corporativa de acesso da Prodabel o Acesso BH.

Em outras palavras para utilização do Endereço Externo, é necessária a criação de um usuário de sistema (AD) que deverá ser cadastrado no Acesso BH com a permissão para o Endereço Externo. Para superar esta etapa siga os passos a seguir:

Passo 1¶

Criação de usuário e permissões para acesso ao Endereço Externo¶

Para acessar os serviços do Endereço Externo é necessário um usuário, do tipo sistema, cadastrado no AcessoPBH.

Caso o sistema ainda não possua usuário, é necessário solicitar para área responsável. Mais informações neste link ou mais informações no manual disponível em autorizacaodesistemas.pbh.gov.br

Passo 2¶

Solicitar concessão de permissão para que o usuário possa acessar os serviços do Endereço Externo. A solicitação deve ser feita na ferramenta Service Desk.

No menu Arquivo > Nova Solicitação. No novo formulário que aparecer no campo Área de Solicitação informe:

Servicos de Tecnologia e Informacao.Geoprocessamento.Sistemas e Servicos Geo.Suporte e Sustentacao

E no campo Item de Configuração informe: ENDERECOEXTERNO

No campo de Resumo informe:

Autorização de usuário no Endereço Externo

No campo Descrição informe login e o nível de permissão no serviço, ex:

Login do usuário
Permissão de leitura

OBS: Existem dois níveis de permissão, leitura e escrita.

Passo 3¶

Caso deseje apenas consultar o Endereço Externo, todo acesso poderá ser feito diretamente no ambiente de produção, na URL https://enderecoexterno.pbh.gov.br/. Este ambiente se encontra aberto na Internet.

Caso necessite de escrita, para cadastrar endereços, o acesso em produção só será liberado mediante solicitação explícita do gerente de projeto via SDM.

Em fase de desenvolvimento e homologação de sistemas, todo acesso ao Endereço Externo deverá ser pelo ambiente de homologação. Obs: Para testes e validação de mudanças no serviço Endereço Externo, os sistemas devem apontar para os respectivos ambientes.

Para ter acesso ao abiente de homologação é necessário acesso a rede da RMI. Caso não esteja fisicametne na rede da RMI / Prodabel, será necessário solicitar acesso à VPN ou a uma máquina remota que esteja na rede.

Esta solicitação também pode ser feita via Service Desk.

Passo 4¶

De posse de um usuário AD com permissão de acesso ao Endereço Externo, você já poderá iniciar os testes de requisição ao serviço. A documentação com todos os endpoints do serviço se encontra em API.