API7 Enterprise v3.3.0 Suporta API Portal

Visão Geral do Portal do Desenvolvedor

O Portal do Desenvolvedor é uma plataforma dedicada projetada para consumidores de API (por exemplo, desenvolvedores de terceiros e equipes internas) que fornece acesso unificado à documentação de API, ferramentas de teste e recursos relacionados. Este portal não apenas facilita que os desenvolvedores entendam e integrem APIs rapidamente, mas também melhora as capacidades de visualização e controle nos níveis de gerenciamento e segurança. Para uma plataforma de gateway de API, oferecer um portal do desenvolvedor permite o seguinte:

1. Exposição Simplificada de API: Ao consolidar documentação fragmentada, exemplos e especificações de interface em uma plataforma unificada, o portal reduz significativamente os custos de integração e acelera a integração do produto com sistemas externos.

2. Melhoria da Eficiência de P&D e Operações: Recursos de autoatendimento, como consulta de documentação, teste e depuração, reduzem a comunicação repetitiva e a manutenção de documentação, aumentando assim a eficiência geral.

3. Gerenciamento e Monitoramento Centralizados: A plataforma fornece um melhor acompanhamento do uso da API, análise de resposta e monitoramento de métricas-chave, além de detectar problemas potenciais antecipadamente.

No API7 Enterprise 3.3.0, o API7 Gateway agora suporta a geração automática de um portal do desenvolvedor diretamente a partir da documentação de API fornecida pelo usuário. Essa capacidade permite que as organizações exponham recursos de API para partes externas com mais facilidade, ao mesmo tempo que oferecem uma experiência consistente e conveniente para os desenvolvedores.

Portal do Provedor API7 e Portal do Desenvolvedor

Como plataformas de gerenciamento de API, o Portal do Provedor API7 e o Portal do Desenvolvedor desempenham papéis complementares, mas atendem a públicos e funcionalidades diferentes.

Portal do Provedor API7

O Portal do Provedor API7 é um console de gerenciamento projetado para provedores de API, facilitando o gerenciamento do ciclo de vida da API com facilidade.

• Público-Alvo: Provedores e administradores de API
• Funções Principais:
  • Publicar e gerenciar produtos de API.
  • Gerenciar desenvolvedores.
  • Configurar políticas de acesso ao Portal do Desenvolvedor, como visualização anônima de API e métodos de login.
  • Visualizar estatísticas de acesso à API, realizar análises e rastrear logs.

Portal do Desenvolvedor API7

O Portal do Desenvolvedor API7 fornece um ponto de entrada unificado e de autoatendimento para desenvolvedores ou parceiros, permitindo que eles entendam, acessem e utilizem serviços de API rapidamente.

• Público-Alvo: Consumidores de API, como desenvolvedores de terceiros, parceiros ou equipes internas de desenvolvimento
• Funções Principais:
  • Fornecer documentação de API, guias de uso e exemplos de código.
  • Oferecer interfaces de teste e depuração online.
  • Gerenciar registro de aplicativos, obtenção de chaves de API e tratamento de credenciais de autenticação.

Como Usar o Portal API7

Acessando o Portal do Provedor API7

Após fazer login no painel do API7 Enterprise, os usuários são direcionados para a página de Gerenciamento de Gateway por padrão. Para alternar para o Portal do Provedor API7, clique no botão de alternância no canto superior esquerdo. Após a alternância, o título da página é atualizado para Portal do Provedor API7, e o menu à esquerda reflete as opções relevantes para gerenciar produtos de API.

Criando e Publicando Produtos de API

Produtos de API são um recurso central no Portal do Provedor API7, representando um grupo de APIs relacionadas. Desenvolvedores normalmente se inscrevem em APIs no nível do produto. Existem dois métodos para criar produtos de API.

1. Com Base em Serviços Publicados no API7 Gateway

• Selecione serviços publicados existentes no API7 Gateway e agrupe-os em um produto de API.
• Dentro do produto de API, cada rota correspondente ao serviço é tratada como uma API independente.

2. Importando Arquivos OpenAPI

• Gere produtos de API rapidamente importando arquivos OpenAPI existentes.
• Observe que os produtos criados dessa forma não estão diretamente vinculados às configurações do gateway.

Exemplo: Adicionando Produto de API a partir do API7 Gateway

Para adicionar um produto de API, clique no botão "Adicionar Produto de API" e selecione o item de menu "Do API7 Gateway" para acessar o formulário de criação de produto de API.

No formulário, você precisa preencher as seguintes informações:

1. Básico: Inclui nome, descrição, rótulos, logotipo, etc.

2. Tipo de Autenticação: Especifique se a aprovação é necessária.

3. Visibilidade: Defina o escopo de visibilidade do produto de API.

4. Serviços de Gateway Vinculados: Selecione um serviço de gateway publicado que atenda às duas condições a seguir:

   • Um nome de host foi configurado.
   • Um documento OpenAPI foi carregado.

Adicionando um Novo Produto de API

Se nenhum serviço atender aos requisitos, você pode seguir as etapas de configuração abaixo.

1. Carregar Documento OpenAPI e Configurar Nome de Host para Serviços Existentes

Na página de detalhes do serviço ou modelo de serviço, clique em Especificação OpenAPI na barra de navegação à esquerda. Em seguida, carregue o documento OpenAPI correspondente para o serviço. Certifique-se de que as definições de API no documento correspondam precisamente às rotas reais do serviço. Isso garante que os desenvolvedores tenham documentação de API precisa durante a depuração e acesso bem-sucedido ao upstream.

Após carregar o documento, você pode visualizá-lo em tempo real, o que reflete a documentação final de API que os desenvolvedores acessarão.

Em seguida, na seção Rotas da página de detalhes do serviço ou modelo, configure os hosts no módulo URL de Solicitação. Por padrão, os hosts são definidos como "*", o que significa que o serviço processa solicitações de qualquer nome de host.

Para vincular o serviço a um produto de API, um host preciso deve ser especificado. Esse requisito garante que os desenvolvedores possam acessar as APIs usando o formato de caminho completo: host + prefixo de caminho + API.

2. Criar um Novo Serviço para Vinculação a um Produto de API

Se nenhum serviço tiver sido publicado, você pode criar um novo serviço carregando um documento OpenAPI como um modelo de serviço e publicando-o, ou criando um serviço diretamente no grupo de gateway. Serviços criados dessa forma analisam automaticamente as APIs definidas no OpenAPI em rotas, mantendo o documento sem necessidade de recarregamento. Configure o host conforme descrito anteriormente para tornar o serviço elegível para vinculação a produtos de API.

Após concluir a configuração do gateway, retorne ao portal do provedor e clique em Adicionar Serviço de Gateway Vinculado. Selecione o serviço publicado necessário para concluir a vinculação.

Por padrão, o novo produto de API criado estará em estado de rascunho, invisível para os desenvolvedores. Antes de publicar, revise a documentação da API, as configurações de visibilidade e as configurações de autenticação. Recomenda-se configurar notificações de eventos de produtos de API (por exemplo, aprovação ou cancelamento de inscrição) para evitar perder atualizações críticas.

Publicando um Produto de API

Após verificar o produto de API, clique no botão Publicar no canto superior direito e confirme. Desenvolvedores que correspondam às configurações de visibilidade poderão acessar o produto através do Portal do Desenvolvedor.

Acessando o Portal do Desenvolvedor API7

Você pode acessar o Portal do Desenvolvedor API7 de duas maneiras:

1. Visite o URL do Portal do Desenvolvedor.
2. Clique no botão Portal do Desenvolvedor no menu à esquerda do painel do Portal API7.

Na página inicial do Portal do Desenvolvedor API7, clique no botão Login no canto superior direito para fazer login.

Criando um Desenvolvedor

Existem duas maneiras de criar uma conta de desenvolvedor:

• Auto-Registro: Desenvolvedores se registram na página de login.
• Convite do Administrador: Administradores criam contas através do painel do Portal API7.

Auto-Registro

Clique no botão Registrar-se na página de login e preencha o formulário com um nome de usuário e senha.

Registro Iniciado pelo Administrador

No painel do Portal API7, navegue até a seção Desenvolvedores e clique em Convidar Desenvolvedor. Preencha o formulário com o nome de usuário e uma senha única e, opcionalmente, forneça um nome de exibição para identificação.

Após adicionar o desenvolvedor, compartilhe o nome de usuário e senha com o usuário. No primeiro login, ele deve redefinir a senha.

Visualizando Produtos de API

Após fazer login, os desenvolvedores podem clicar em API Hub para visualizar todos os produtos de API publicados.

Além de visualizar a documentação da API, o sistema também suporta a geração de exemplos de código em vários idiomas para cada API na página de detalhes. Os desenvolvedores podem copiar esses exemplos de código para seu ambiente de desenvolvimento para teste.

Depurando Produtos de API

Além disso, os desenvolvedores podem testar APIs diretamente clicando no botão Testar Solicitação.

Após clicar em Testar Solicitação, você pode ver um painel de teste online.

• O URL de Solicitação é gerado automaticamente com base na configuração do serviço associado ao produto de API.
• O Método de Autenticação padrão é Key Auth e preenche automaticamente a Chave de API para a conta do desenvolvedor atual.

Os desenvolvedores só precisam complementar os parâmetros de solicitação necessários de acordo com a definição da interface da API para prosseguir com a depuração.

Inscrevendo-se em Produtos de API

Se um produto de API for restrito a usuários específicos, o administrador do portal do provedor pode desativar a opção Desenvolvedores não inscritos podem visualizar detalhes da API nas configurações de visibilidade do produto. Isso garante que os desenvolvedores devem se inscrever no produto antes de acessar ou invocar suas APIs.

Quando um desenvolvedor acessa a página de detalhes do produto de API sob essa configuração, um botão "Inscrever-se para Desbloquear" será exibido. Clicar no botão envia uma solicitação de inscrição ao administrador do provedor.

Se o processo de aprovação estiver habilitado para o produto de API, o desenvolvedor deve aguardar a aprovação do administrador antes de obter acesso para visualizar os detalhes.

No menu Organização do Portal do Provedor API7, se houver aprovações pendentes, um ponto vermelho aparecerá ao lado do item de menu Aprovações como um indicador. Clicar nesse item de menu navega até a página de gerenciamento de aprovações.

A página de aprovações é projetada para gerenciar solicitações de desenvolvedores para acessar recursos de API. Os administradores podem revisar as seguintes informações de solicitação nesta página: tipo de evento, nome do recurso, solicitante e horário da solicitação. Através da interface, os administradores podem tomar ação para Aprovar ou Rejeitar a solicitação.

A decisão de aprovação impacta diretamente as permissões de acesso à API do desenvolvedor:

• Aprovar: O desenvolvedor obtém acesso para visualizar a página de detalhes do produto de API e invocar a API.
• Rejeitar: O desenvolvedor deve se comunicar com o administrador, fazer ajustes necessários com base no feedback e reenviar a solicitação.

Conclusão

O API7 Enterprise integra a plataforma de gateway de API com um portal do desenvolvedor para criar uma solução eficiente de gerenciamento de API tanto para provedores de API quanto para desenvolvedores.

O Portal do Provedor API7 permite que os provedores de API publiquem, gerenciem e monitorem produtos de API com facilidade, enquanto coordenam efetivamente os recursos dos desenvolvedores. Enquanto isso, os desenvolvedores podem entender, integrar e utilizar serviços de API de forma eficiente, acelerando o desenvolvimento de aplicativos. Esses dois portais trabalham em sinergia para simplificar o processo de gerenciamento do ciclo de vida da API, tornando cada etapa—da implantação à invocação—mais suave e eficiente.