API Portal - Integração Manager

Esta seção apresenta a integração entre Portal e Manager, envolvendo os Environments relacionado ao API Browser.

1. Como configurar

Para acessar o menu de configurações, basta acessar as seguintes opções:

Inicialmente, é necessário informar a URL do Manager, bem como usuário e senha, conforme mostra a imagem abaixo:

Uma vez configurado o usuário e senha, serão apresentandos todos os Environments nas opções Developer Dashboard Environments e API Browser Environments, conforme exibido na imagem a seguir:

É possível selecionar quais Environments estarão visiveis no API Browser. Veja a ilustração a seguir:

2. Como funciona o 'API Browser Environments'

Essa configuração determina quais Environments serão empregados no API Browser. Se, porventura, nenhum Environment for selecionado, será considerado o Environment padrão discriminado em cada API configurada no Manager.

2.1. Listagem de APIs

A importação do Swagger pode ser realizada de forma manual ou de forma automática com base nos Environments selecionados na área API Browser Environments.

OBS: o Swagger importado de forma manual tem maior prioridade porque possibilita configurações de papéis. Ex: se a API do Metrics Versão 3.0.0 for configurada de forma manual e a mesma API estiver configurada para ser apresentada de forma automática, será considerada a de forma manual por ser mais restritiva com relação aos papéis determinados no ato do upload.

A imagem abaixo apresenta a tela de API Browser, listando uma API importada de um Swagger dentro Portal:

2.2. API Browser

Nesta página é apresentada a documentação da API (Swagger). O campo Server apresenta todos os Environments na qual àquela API possui vínculo. Uma vez selecionado um Environment, a documentação é carregada apontando para o endereço (servidor) em questão.