Portal¶

Introdução¶

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

A página do Portal pode ser acessada através da aplicação API Manager, através 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 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 tenha recebido um mínimo de acesso 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 Customizada

  • 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 deverá ter sido previamente gerada e publicada através do Gerenciador do Portal página.

A página Portal pode ser acessada no menu do Harmony Portal ou em outras páginas do API Manager:

• Da Casa ou Downloads ou nas páginas Cloud Studio, Vinyl, Marketplace, Management Console, EDI, ou Citizen Integrator, use o menu Harmony Portal no canto superior esquerdo para acessar API Manager > Portal:

  

• Em Minhas APIs, Gerenciador do Portal, Registros de API, Análise, Perfis de segurança, Grupos de IPs Confiáveis ou Grupos de API, use o menu de navegação do API Manager para selecionar Portal:

  

Além do acesso pelo aplicativo API Manager, a página do 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 têm 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 Portal do API Manager ou o link para Visualizar documentação da API na página 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, siga um destes procedimentos:

  • Acesse a página do Portal e copie sua URL.

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

    

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

  Após fazer login, a página Portal será exibida. A página Portal exibe a documentação do OpenAPI 2.0 gerada a partir do Gerenciador do Portal e permite testar 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 atualmente selecionada sendo acessado.

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

  • Copiar: Clique no ícone de cópia 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.

Testar APIs¶

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

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