Portal¶

Introdução¶

A página Portal é gerenciada pelo Gerenciador do Portal e permite que você acesse e use a documentação interativa gerada do OpenAPI 2.0 para testar APIs personalizadas e proxy. Esta página descreve a interface do usuário da página Portal dentro do API Manager.

A página do Portal pode ser acessada por meio do aplicativo API Manager, por meio de um convite de um administrador da organização Harmony, ou por meio de um link direto para aqueles com permissões de organização e acesso ao ambiente suficientes.

Acesse a Página do Portal¶

Antes de poder acessar a página do Portal, estes critérios devem ser atendidos:

• Para cada API cuja documentação se torna acessível na página Portal, uma papel de organização que recebeu um mínimo de acesso de Leitura em um ambiente deve ser selecionada na configuração da API. Consulte estes recursos:

  • Etapa 3: Atribuir funções de usuário e perfis de segurança em configuração de API personalizada

  • Etapa 3: Atribuir funções de usuário e perfis de segurança em configuração do serviço OData

• A documentação da API deve ter sido previamente gerada e publicada através do Portal Manager página.

A página Portal pode ser acessada pelo menu do portal Harmony ou pelo menu de navegação do API Manager:

• Use o menu do portal Harmony para selecionar API Manager > Portal:

  

• Ao acessar uma página do API Manager, use seu menu de navegação para selecionar Portal:

  

Além do acesso pelo aplicativo API Manager, a página Portal pode ser acessada por:

• Um convite de um administrador da organização Harmony através do Management Console Gerenciamento de Usuários página.

• Um link direto para consumidores de API que tenham permissão ApiConsumer em uma organização e um mínimo de acesso Read em um ambiente (consulte Permissões e acesso do Harmony). Para obter o link direto, copie a URL da página do Portal do API Manager ou o link para Exibir documentação da API na página do Portal Manager.

  Para obter o link direto para fornecer a um consumidor de API que tenha a permissão e o nível de acesso necessários, faça um destes:

  • Vá para a página do Portal e copie seu URL.

  • Do Gerenciador do Portal, clique em Exibir documentação da API:

    

  Ao acessar o link direto para o Portal, se os usuários ainda não estiverem logados, eles serão apresentados a uma página de login genérica que é separada da página de login do portal Harmony. Embora a página de login pareça diferente daquela mostrada para o portal Harmony, as credenciais necessárias são as mesmas usadas para fazer login no portal Harmony.

  Após efetuar login, a página Portal é exibida. A página Portal exibe a documentação do OpenAPI 2.0 gerada pelo Portal Manager e permite que você teste APIs personalizadas e de proxy.

Cabeçalho da Página do Portal¶

Esses detalhes e ações estão disponíveis na parte superior da página do Portal:

• Organização: O nome da organização selecionada no momento sendo acessado.

• URL base: O URL base das APIs na organização.

  • Copiar: Clique para copiar o URL base para sua área de transferência.

• Ambiente: Exibe o ambiente que está sendo acessado no momento. Use o menu para selecionar outro ambiente.

APIs de Teste¶

Você pode usar a documentação interativa para testar chamadas de API personalizadas e de proxy para validar se elas estão funcionando corretamente.

Como a interface é a mesma gerada e descrita na página Portal Manager, consulte APIs de teste no Gerenciador do Portal página.