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

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

O portal de serviços para desenvolvedores atua como um cliente do Apigee Edge. Isso significa que o portal não funciona como um sistema independente. Em vez disso, muitas das informações usadas pelo portal são armazenadas no Edge. Quando necessário, o portal faz uma solicitação HTTP ou HTTPS para extrair informações do Edge ou enviar informações para ele.

O Edge não faz solicitações ao portal, apenas responde a solicitações feitas no portal. Portanto, todas as interações entre o portal e o Edge são iniciadas pelo portal.

Configurar a conexão entre o portal e o Edge

O portal precisa de três informações para se comunicar com o Edge, conforme indicado abaixo.

• URL do endpoint do Edge
  
  O endpoint padrão para a versão baseada na nuvem do Edge é https://api.enterprise.apigee.com/v1.
  
  Para a instalação do Private Cloud, o URL tem o 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 ao criar sua conta no Edge.
• Nome de usuário e senha de um administrador de desenvolvedor
  
  As chamadas do portal para o Edge são autenticadas e exigem um usuário com privilégios de Administrador de desenvolvedor. Quando um portal do desenvolvedor é provisionado para você, o papel de administrador do desenvolvedor é adicionado à sua organização. Essa função, que inclui um único usuário chamado devadmin+{org_name}@apigee.com, tem o único objetivo de conectar o portal do desenvolvedor à sua organização do Edge. Como o portal mostra seus apps de desenvolvedor do Edge, produtos de API e assim por diante, ele precisa ficar em sincronia com sua organização do Edge fazendo chamadas de API de gerenciamento que exigem autenticação. O "usuário" do devadmin tem as permissões necessárias.
  

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

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

Para mudar a configuração:

A forma de mudar a configuração depende da instalação e da versão do portal:

• Instalação baseada em nuvem da versão 15.01.06 e mais recentes do portal: é necessário fazer uma solicitação ao suporte do Apigee Edge para mudar as informações de conexão. Por exemplo, se você quiser mudar o nome da organização.
• Instalação local e portal baseado em nuvem anterior à versão 15.01.06: mude 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 na API Management.
3. Insira o URL do endpoint do Edge em URL do endpoint da API Management.
4. Insira as credenciais do 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 bem-sucedida.
6. Selecione Save Configuration.

Garantir o acesso ao Edge pelo portal

Como muitas das informações usadas pelo portal são armazenadas no Edge, é necessário 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 ao Edge para enviar informações sobre o app.

O Edge e o portal podem ser implantados na nuvem ou no local, e você pode misturar os tipos de implantações. Por exemplo, você pode implantar os dois na nuvem, no local ou um na nuvem e outro no local:

• Se o portal e o Edge forem implantados pela Apigee na nuvem, não haverá problemas em fazer solicitações do portal para o Edge.
• Se você implantar o portal no local, será necessário garantir que ele possa fazer solicitações para o Edge, independentemente de ele estar implantado na nuvem ou no local.
• Se você implantar o Edge no local, verifique se o portal tem acesso a ele. 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 app para o Edge, incluindo o nome do app e os produtos de API associados a ele.

Se o Edge registrar o app, ele vai retornar uma única chave de API para o portal. 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 usa o portal para conferir informações sobre um app, o portal faz uma solicitação ao Edge para acessar essas informações. Sempre que o desenvolvedor modifica um app, o portal envia automaticamente essas modificações para o Edge.

Por exemplo, um desenvolvedor faz login no portal e navega até a página "Meus apps". Para preencher a página "My Apps", o portal faz uma solicitação ao Edge para extrair 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 vai enviar essas modificações para o 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 interface do Edge. Por exemplo, um administrador pode:

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

Confira abaixo o mesmo app, "My Weather App", como ele aparece para um administrador na interface do Edge:

Como gerenciar desenvolvedores pelo portal

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

As informações do desenvolvedor armazenadas no Edge incluem:

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

O portal armazena as mesmas informações do Edge, mas também armazena informações adicionais, incluindo:

• Senha do portal
• Status da conta do Portal: ativa ou bloqueada
• Função do portal: usuário autenticado, administrador, outro
• Permissões baseadas em função: determinam as ações que o desenvolvedor pode realizar no portal.

Quando um desenvolvedor faz login no portal, ele é responsável por autenticar o desenvolvedor e aplicar as permissões baseadas em função.

Como o portal armazena todas as informações sobre um desenvolvedor, considere o portal 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, essas informações serão enviadas ao Edge. No entanto, se o desenvolvedor mudar a senha, essas informações serão armazenadas apenas localmente no portal.

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

Como sincronizar 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 do portal para o Edge. No entanto, se você só modificar os desenvolvedores no portal e não no Edge, nunca precisará realizar essa sincronização. Além disso, como o Edge não permite definir uma senha ao criar um desenvolvedor, a senha do portal de qualquer desenvolvedor criado no Edge é 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 um 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 Sincronização com desenvolvedores do portal do desenvolvedor na parte de cima da página para sincronizar com os desenvolvedores de apps no Edge.