Página do Portal no Jitterbit API Manager
Introdução
A página Portal é gerenciada a partir da página Portal Manager e permite acessar e usar a documentação interativa gerada do OpenAPI 2.0 para testar APIs personalizadas e de proxy. Esta página descreve a interface do usuário da página Portal dentro do API Manager.
Nota
A geração de documentação OpenAPI para APIs OData não é suportada.
A página Portal pode ser acessada através do aplicativo API Manager, por meio de um convite de um administrador da organização Harmony, ou através de um link direto para aqueles com permissões suficientes na organização e acesso ao ambiente.
Acessar a página do Portal
Antes de acessar a página Portal, os seguintes critérios devem ser atendidos:
-
Para cada API cuja documentação se torne acessível a partir da página Portal, deve ser selecionado um papel de organização que tenha recebido um mínimo de acesso Leitura em um ambiente na configuração da API, veja esses recursos:
-
A documentação da API deve ter sido gerada e publicada anteriormente através da página Portal Manager.
Para acessar a página Portal, use o menu do portal Harmony para selecionar API Manager > Portal.
Além do acesso através do menu do portal Harmony, a página Portal pode ser acessada por:
-
Um convite de um administrador da organização Harmony através da página Gerenciamento de Usuários do Console de Gerenciamento.
-
Um link direto para consumidores de API que possuem a permissão ApiConsumer em uma organização e um mínimo de acesso Read em um ambiente (veja permissões e acesso do Harmony). Para obter o link direto, copie o URL da página Portal do Gerenciador de API ou o link para Ver Documentação da API na página Gerenciador do Portal.
Para obter o link direto a ser fornecido a um consumidor de API que possui a permissão e nível de acesso necessários, faça uma das seguintes ações:
-
Vá para a página Portal e copie seu URL.
-
Na página Gerenciador do Portal, clique em Ver Documentação da API:
Ao acessar o link direto para o Portal, se os usuários não estiverem logados, eles sã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 da mostrada para o 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 é exibida. A página Portal exibe a documentação OpenAPI 2.0 gerada a partir da página Gerenciador do Portal e permite que você teste APIs personalizadas e de proxy.
-
Cabeçalho da página Portal
Esses detalhes e ações estão disponíveis na parte superior da página Portal:
-
Organização: O nome da organização atualmente selecionada que está sendo acessada.
-
URL Base: A URL base das APIs na organização.
- Copiar: Clique para copiar a URL Base para sua área de transferência.
-
Ambiente: Exibe o ambiente que está sendo acessado atualmente. Use o menu para selecionar outro ambiente.
Testar APIs
Você pode usar a documentação interativa para testar chamadas de API personalizadas e de proxy a fim de validar se estão funcionando corretamente.
Como a interface é a mesma que a gerada e descrita na página do Portal Manager, consulte Testar APIs na página do Portal Manager.