Como criar seu portal integrado

A Apigee oferece um portal integrado e simples de usar para documentar e gerenciar o acesso às suas APIs e promover sua comunidade de desenvolvedores de aplicativos.

Todos os usuários da Apigee têm acesso às ferramentas de desenvolvimento do portal integrado que permitem criar o próprio portal do desenvolvedor rapidamente, oferecendo uma alternativa ao desenvolvimento do portal com base no Drupal. Para uma comparação de recursos, consulte Comparação de recursos do portal do desenvolvedor.

Assista a este breve vídeo para uma introdução à criação e publicação de um portal integrado.

Principais recursos e benefícios

O portal integrado oferece os seguintes recursos e benefícios:
Recurso Vantagens
Desenvolvimento de conteúdo do portal Desenvolva o conteúdo do portal de forma rápida e fácil.
  • Criar páginas usando o editor de páginas simples de usar
  • Usar Markdown e HTML para compor conteúdo
  • Adicionar menus para navegar no seu portal
Aparência do portal Personalize totalmente a aparência do seu portal usando folhas de estilo SCSS e marcas personalizadas.
Documentação da API Gere automaticamente a referência da API com base nas especificações da OpenAPI.
Registro de autoatendimento Fornece registro de autoatendimento para que os desenvolvedores criem apps usando suas APIs.
Gerenciamento de público-alvo Controlar quem pode acessar o conteúdo e as APIs do portal
Analytics Configure o Google Analytics e o acompanhamento de análise personalizado.
Personalizações avançadas Realize personalizações avançadas de portal, incluindo:
  • Personalizar seu domínio
  • Adicionar campos de registro personalizados
  • Estender seu portal usando scripts
  • Configurar seu e-mail

Como a Apigee aborda a segurança no portal integrado

A tabela a seguir descreve como a Apigee aborda a segurança por meio de recursos integrados no portal integrado.

Recurso Endereços
Requer segurança HTTPS e de camada de transporte (TLS) Aplica a comunicação criptografada
Inclui registro de domínio apigee.io com Lista de sufixos públicos Impede que os "supercookies" sejam definidos nos subdomínios de apigee.io
Exige:
  • Limpeza de entradas de formulário
  • Injeção de JavaScript para todo o site restrita aos administradores
Protege contra ataques de injeção de HTML, SQL ou back-end
Inclui cabeçalho XSS x-content-type-options: nosniff Não permite que navegadores tentem adivinhar tipos MIME
Inclui cabeçalho XXS x-frame-options: deny Não permite a incorporação de conteúdo do portal em um iFrame
Inclui cabeçalho XXS x-xss-protection: 1 Não permite o carregamento das páginas quando elas detectam ataques de scripting em vários locais (XSS)
Usa tokens CSRF Protege contra falsificação de solicitações entre vários locais
Aproveita: Proteção de dados do cliente

Como o portal integrado se comunica com a Apigee

A maioria das informações usadas pelo portal do desenvolvedor é armazenada na Apigee. O portal atua como um cliente da Apigee. Conforme necessário, o portal do desenvolvedor envia uma solicitação REST HTTP ou HTTPS para recuperar informações da Apigee ou enviá-las à Apigee. Por exemplo, quando um usuário registra um novo aplicativo no portal, o portal envia uma solicitação à Apigee para armazenar informações sobre o aplicativo.

Veja mais detalhes nas seções a seguir.

Em que as chaves de API e o registro do app são armazenados

Quando um usuário do portal conclui o processo de registro do aplicativo no portal integrado, o portal envia informações sobre o aplicativo para a Apigee, incluindo o nome do aplicativo e os produtos da API associados ao aplicativo. Se a Apigee registrar o aplicativo, a Apigee retornará uma única chave de API ao portal. O usuário do portal usa essa chave de API para acessar os produtos de API associados ao aplicativo.

As informações sobre os apps e as chaves de API são armazenadas apenas na Apigee e não no portal. Quando um usuário do portal usa o portal para visualizar informações sobre um app, por exemplo, na página "My Apps", o portal faz uma solicitação à Apigee com a chave de API para acessar as informações.

Da mesma forma, quando um usuário do portal adiciona, remove ou modifica um aplicativo, o portal envia as modificações à Apigee para serem armazenadas.

Como todas as informações sobre apps e chaves de API são armazenadas na Apigee, um administrador da Apigee pode modificar essas informações usando a IU da Apigee ou API de gerenciamento. Por exemplo, um administrador pode:

  • Adicionar, remover ou modificar um app do desenvolvedor
  • Aprovar ou revogar uma chave de API de um app do desenvolvedor

Para mais informações, consulte Registrar aplicativos e gerenciar chaves de API.

Onde as informações da conta do desenvolvedor são armazenadas

As informações da conta de desenvolvedor são armazenadas na Apigee, da seguinte maneira:

As seguintes informações da conta do desenvolvedor são armazenadas na Apigee:

  • Nome e sobrenome
  • Endereço de e-mail
  • Nome de usuário
  • Status da conta do portal (ativa ou inativa)
  • Papel do portal (usuário autenticado, administrador, outro)
  • Permissões baseadas em papéis

O endereço de e-mail é a chave principal usada pela Apigee para identificar a conta de desenvolvedor, e cada uma precisa ser exclusiva. A partir da chave primária, a Apigee gera um ID de desenvolvedor exclusivo para cada organização a que a conta de desenvolvedor pertence.

Para mais informações, consulte Registrar desenvolvedores de apps.

Sobre o portal de amostra

Quando você cria um novo portal, um conjunto de páginas iniciais é fornecido para uso como ponto de partida. As páginas iniciais têm conteúdo de demonstração para inspirar o desenvolvimento do seu portal à medida que você substitui o texto e as imagens pelo seu conteúdo exclusivo. O tema do portal de amostra usa temas de material de design e SCSS.

A seguir, mostramos a página inicial do portal de amostra.

As páginas iniciais fornecidas com o portal de amostra incluem:

Page Descrição
Home Página inicial do portal que descreve as APIs exibidas. Exibe a página inicial padrão do seu portal (index.html). Demonstra o uso de componentes de material angular, conforme descrito em Adicionar componentes de material angular.
Início rápido Conjunto de etapas rápidas que demonstram como personalizar o portal. Consulte o Guia de início rápido.
Primeiros passos Página de conteúdo de amostra. Saiba como editar essa página e adicioná-la à navegação superior seguindo o início rápido.
APIs Lista de APIs disponíveis. Quando você gera documentação de referência da API interativa, links para o conteúdo são adicionados automaticamente a esta página.

Observação: o conteúdo desta página é gerado automaticamente com base nas APIs que você publica no seu portal. Não é possível editar o conteúdo desta página diretamente. Ele não será exibido na lista de páginas. É possível modificar o estilo da página usando o editor de temas do portal.
Meus aplicativos Lista de aplicativos registrados para um usuário autorizado. Consulte Como os usuários do portal interagem com seu portal.

Observação: o conteúdo desta página é gerado automaticamente com base nos aplicativos do usuário registrados. Não é possível editar o conteúdo da página diretamente. Ele não será exibido na lista de páginas. É possível modificar o estilo da página usando o editor de temas.
Faça login Página de login para usuários registrados. Novos usuários podem se registrar nesta página clicando em Fazer login. Consulte Como os usuários do portal interagem com seu portal.

Observação: a página de login é incluída automaticamente no portal. Você pode personalizar o logotipo na página de login e adicionar campos de registro personalizados à página "Criar conta". Não é possível editar o conteúdo da página diretamente. Ele não será exibido na lista de páginas. ”
Termos e Condições Amostra de página de Termos e Condições.