Comunicação entre um portal baseado no Drupal e o Edge

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

O portal de serviços para desenvolvedores atua como um cliente da Apigee Edge. Isso significa que o portal não funciona como um sistema autônomo. Em vez disso, grande parte das informações usadas pelo portal é armazenada no Edge. Quando necessário, o portal faz uma solicitação HTTP ou HTTPS para recuperar informações do Edge ou enviar informações para o Edge.

O Edge não faz solicitações ao portal, apenas responde às solicitações feitas nele. Portanto, todas as interações entre o portal e o Edge são iniciadas por ele.

Configure a conexão entre o portal e o Edge

Há três informações que o portal precisa se comunicar com o Edge, conforme observado abaixo.

• URL do endpoint do Edge
  
  O endpoint padrão da versão do Edge baseada na nuvem é https://api.enterprise.apigee.com/v1.
  
  Para instalação da nuvem privada, o URL está no formato: http://EdgePrivateCloudIp:8080/v1 ou https://EdgePrivateCloudIp:TLSport/v1.
  
  Em que EdgePrivateCloudIp é o endereço IP do servidor do servidor de gerenciamento de borda e TLSport é a porta TLS/SSL para a API de gerenciamento de borda. Por exemplo, 8443.
• Nome da organização da Apigee
  
  Esse é o nome da sua organização no Edge. Você configura a organização quando cria sua conta no Edge.
• Nome de usuário e senha de um administrador desenvolvedor
  
  As chamadas do portal para o Edge são autenticadas e exigem um usuário com privilégios de administrador do desenvolvedor. Quando um portal do desenvolvedor é provisionado para você, o papel de administrador do desenvolvedor é adicionado à sua organização. Esse papel, que inclui um único usuário chamado devadmin+{org_name}@apigee.com, tem a finalidade única de conectar seu Portal do desenvolvedor à organização do Edge. Como o portal exibe seus apps de desenvolvedor do Edge, produtos de API e assim por diante, ele precisa permanecer sincronizado com sua organização do Edge, fazendo chamadas de API de gerenciamento que exigem autenticação. O "user" de devadmin tem as permissões necessárias.
  

Para visualizar as informações de conexão:

1. No menu de administração do Drupal, selecione Configuration > Dev Portal > Application Settings.

Para alterar a configuração:

A mudança da configuração depende da instalação e da versão do portal:

• Instalação do portal 15.01.06 e mais recentes na nuvem: você precisa fazer uma solicitação ao suporte do Apigee Edge para alterar as informações de conexão. Por exemplo, se você quiser alterar o nome da organização.
• Instalação local e portal baseado na nuvem anterior à versão 15.01.06: altere as informações de conexão conforme descrito abaixo:

1. No menu de administração do Drupal, selecione Configuration > Dev Portal Settings.
2. Insira o nome da sua organização em Organização da API Management.
3. Insira o URL do endpoint do Edge em URL do endpoint da API Management.
4. Digite as credenciais de administrador da organização em Usuário autenticado do endpoint e Senha do usuário autenticado.
5. Selecione Testar conexão para verificar se a conexão foi estabelecida.
6. Selecione Save Configuration.

Como garantir o acesso ao Edge pelo portal

Como grande parte das informações usadas pelo portal são armazenadas no Edge, você precisa garantir que o portal possa acessar o Edge. O portal inicia a comunicação com o Edge fazendo solicitações REST por HTTP e HTTPS. Por exemplo, quando um desenvolvedor registra um novo app no portal, o portal faz uma solicitação para que o Edge envie informações sobre o app.

O Edge e o portal podem ser implantados na nuvem ou no local, e você pode combinar os tipos de implantação. Por exemplo, é possível implantar na nuvem, tanto no local quanto implantar um na nuvem e outro no local:

• Se o portal e o Edge forem implantados pela Apigee na nuvem, não haverá problemas ao fazer solicitações do portal para o Edge.
• Se você implantar o portal no local, será necessário garantir que o portal possa fazer solicitações ao Edge, independentemente de o Edge estar implantado na nuvem ou no local.
• Se você implantar o Edge no local, verifique se o portal tem acesso ao Edge. Isso significa que seu servidor de borda precisa aceitar solicitações do portal, independentemente de ele estar implantado na nuvem ou no local.

Como gerenciar apps e chaves de API no portal

Quando o desenvolvedor conclui o processo de registro do app no portal, o portal envia informações sobre o aplicativo para o Edge, incluindo o nome do app e os produtos de API associados a ele.

Se o Edge registrar o app, o Edge retornará uma única chave de API para o portal. Em seguida, o desenvolvedor usa essa chave para acessar os produtos de API associados ao app.

Nenhuma informação sobre apps e chaves de API é armazenada no portal. Em vez disso, todas essas informações são armazenadas no Edge. Portanto, sempre que um desenvolvedor usar o portal para visualizar informações sobre um app, ele fará uma solicitação ao Edge para acessar essas informações. Sempre que o desenvolvedor modifica um app, o portal envia automaticamente essas modificações ao Edge.

Por exemplo, um desenvolvedor faz login no portal e acessa a página "Meus apps". Para preencher a página "Meus apps", o portal faz uma solicitação ao Edge para recuperar informações sobre os apps e as chaves de API do desenvolvedor. Essas informações aparecem na página "Meus apps" do desenvolvedor no portal:

Se o desenvolvedor adicionar, remover ou modificar um app, o portal enviará essas modificações ao Edge.

Como todas as informações sobre apps e chaves de API são armazenadas no Edge, um administrador do Edge pode manipular essas informações usando a IU do Edge. Por exemplo, um administrador pode:

• Adicionar, remover ou modificar o app de um desenvolvedor
• Revogar ou aprovar uma chave de API para um app

Veja abaixo o mesmo aplicativo, o "My Weather App", como aparece para um administrador na interface do Edge:

Como gerenciar desenvolvedores pelo portal

Quando um desenvolvedor se registra como novo usuário do portal, ele é criado no Edge e no portal. Portanto, ao contrário de apps e chaves de API, as informações sobre os desenvolvedores são armazenadas no Edge e no portal.

Estas são as informações do desenvolvedor armazenadas no Edge:

• Nome
• Sobrenome
• Endereço de e-mail
• Informações adicionais opcionais enviadas pelo portal

O portal armazena as mesmas informações que o Edge, mas também armazena outras informações, incluindo:

• Senha do portal
• Status da conta do portal: ativa ou bloqueada
• Função do portal: usuário autenticado, administrador, outro
• Permissões com base em papéis: determine as ações que o desenvolvedor pode realizar no portal

Quando um desenvolvedor faz login no portal, é ele que é responsável por autenticar o desenvolvedor e aplicar permissões com base em papéis.

Como o portal armazena todas as informações sobre um desenvolvedor, considere-o como o sistema de registro de informações do desenvolvedor, não o Edge. Quando o desenvolvedor modifica as informações no portal, elas são armazenadas no portal e, se aplicável, enviadas para o Edge. Por exemplo, se o desenvolvedor mudar o nome, essa informação será enviada ao Edge. No entanto, se o desenvolvedor alterar a senha, essas informações serão armazenadas apenas localmente no portal.

Para mais informações, consulte Adicionar e gerenciar contas de usuário.

Sincronização de desenvolvedores de apps entre o portal e o Edge

O Edge não inicia a comunicação com o portal. Se você, como administrador do Edge, manipular informações sobre um desenvolvedor na interface do Edge, não haverá garantia de quando essas informações serão enviadas para o portal. Portanto, use os recursos de administração do portal para criar, modificar e excluir desenvolvedores, não o Edge.

Um administrador do portal pode forçar uma sincronização entre o portal e o Edge para fazer o download de informações para o portal do Edge. No entanto, se você modificar apenas os desenvolvedores no portal, e não no Edge, nunca precisará executar essa sincronização. Além disso, como o Edge não permite que você defina uma senha ao criar um desenvolvedor, qualquer desenvolvedor criado no Edge tem a senha do portal definida como um valor aleatório. Portanto, o desenvolvedor precisa passar pelo processo de recuperação de senha antes de fazer login no portal.

Para sincronizar o portal com os desenvolvedores de apps no Edge

:

• Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
• Selecione Pessoas no menu de administração do Drupal.
• Selecione o botão Dev Portal Developer Sync na parte superior da página para sincronizar com os desenvolvedores de apps no Edge.