Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
O Apigee Edge oferece um portal integrado e simples de usar para documentar e gerenciar o acesso às APIs e promover sua comunidade de desenvolvedores de aplicativos.
Todos os usuários do Apigee Edge têm acesso às ferramentas integradas de desenvolvimento do portal. Assim, eles podem criar o próprio portal do desenvolvedor rapidamente, oferecendo uma alternativa ao desenvolvimento de portal baseado 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 principais:| Recurso | Vantagens |
|---|---|
| Desenvolvimento de conteúdo do portal | Desenvolva o conteúdo do portal de maneira rápida e fácil.
|
| 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 |
| Análise de dados | Configure o Google Analytics e o acompanhamento de análise personalizado. |
| Personalizações avançadas | Realize personalizações avançadas do portal, incluindo:
|
Comece a criar seu portal
Como a Apigee lida com 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 HTTPS e TLS (Transport Layer Security) | Aplica comunicação criptografada |
Inclui o registro de domínio do apigee.io com a lista de sufixos públicos
|
Não permite que "supercookies" sejam definidos em subdomínios de apigee.io
|
| Compatível com a configuração da Política de Segurança de Conteúdo (CSP) | Protege contra scripting em vários locais (XSS) e outros ataques de injeção de código |
Requer:
|
Protege contra ataques de injeção de HTML, SQL ou back-end |
Inclui o cabeçalho XSS x-content-type-options: nosniff
|
Não permite que os navegadores tentem adivinhar tipos MIME |
Inclui o cabeçalho XSS x-frame-options: deny
|
Não permite a incorporação de conteúdo do portal em um iframe |
Inclui o cabeçalho XSS x-xss-protection: 1
|
Impede o carregamento de páginas quando elas detectam ataques refletidos de scripting em vários sites (XSS) |
| Usa tokens CSRF | Protege contra falsificação de solicitações entre sites |
Aproveita:
|
Proteção de dados do cliente |
Como o portal integrado se comunica com o Edge
A maioria das informações usadas pelo portal do desenvolvedor é armazenada no Apigee Edge. O portal funciona como um cliente para o Edge. Conforme necessário, o portal do desenvolvedor envia uma solicitação REST HTTP ou HTTPS para recuperar ou enviar informações para o Edge. Por exemplo, quando um usuário registra um novo app, o portal envia uma solicitação ao Edge para armazenar informações sobre o app.
Veja mais detalhes nas seções a seguir.
Onde as chaves de API e o registro do app são armazenados
Quando um usuário do portal conclui o processo de registro de app no portal integrado, o portal envia informações sobre o app para o Apigee 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. 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 no Edge, não no portal. Quando um usuário acessa informações sobre um app na página "Meus apps", por exemplo, o portal faz uma solicitação ao Edge com a chave de API para acessar as informações.
Da mesma forma, quando um usuário do portal adiciona, remove ou modifica um app, o portal envia as modificações ao Edge para serem armazenadas.
Como todas as informações sobre apps e chaves de API são armazenadas no Edge, um administrador do Edge pode modificar as informações usando a interface ou a API de gerenciamento do Edge. 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 do app são armazenadas
As informações da conta do desenvolvedor são armazenadas no Edge da seguinte maneira:
- Com o provedor de identidade integrado ativado, as informações de um usuário do portal são armazenadas no provedor de identidade quando o usuário cria uma conta. As informações são exibidas na página Usuários.
- Com o provedor de identidade de SAML, ativado, um registro de sombra das informações é armazenado no provedor de identidade quando um usuário do portal faz login no portal. O registro de sombra é exibido na página Usuários.
- Depois que um usuário do portal registra um app de desenvolvedor, as informações da conta do usuário são sincronizadas e ficam disponíveis no Edge na Página para desenvolvedores.
As seguintes informações da conta de usuário são armazenadas no Edge:
- Nome e sobrenome
- Endereço de e-mail
- Nome de usuário
- Status da conta do portal (ativa ou inativa)
- Função do portal (usuário autenticado, administrador, outro)
- Permissões com base em papéis
- Equipes em que o usuário do portal é membro (se você tiver inscrito na versão Beta do recurso "Equipes")
O endereço de e-mail é a chave primária usada pelo Edge para identificar o desenvolvedor, e cada um precisa ser único. Na chave primária, o Edge gera um ID de desenvolvedor exclusivo para cada organização a que o desenvolvedor pertence.
Para mais informações, consulte Registrar desenvolvedores de apps.
Onde as informações da equipe de desenvolvedores são armazenadas (Beta)
Quando um usuário do portal cria uma equipe de desenvolvedores no portal, as informações dela são armazenadas no Edge, incluindo:
- Nome e descrição da equipe de desenvolvedores
- Membros da equipe de desenvolvimento e os papéis deles
- Apps a que a equipe de desenvolvedor foi atribuída
- Públicos-alvo atribuídos à equipe de desenvolvedores
- Horário em que a equipe de desenvolvedores foi criada
Um endereço de e-mail exclusivo gerado automaticamente é gerado para a equipe de desenvolvimento e serve como a chave primária usada pelo Edge para identificar a equipe de desenvolvimento.
Para mais informações, consulte Responsabilidade de compartilhamento de um app usando equipes de desenvolvedores (Beta) e Como gerenciar equipes de desenvolvedores.
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:
| página; | Descrição |
|---|---|
| Página inicial | 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. Clique em Início rápido no portal de exemplo para adicionar conteúdo à página Começar. |
| Começar | Página de conteúdo de amostra. Consulte a página Primeiros passos no portal de amostra para saber como editar e adicioná-la à navegação superior. |
| 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. |
| 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. |
Suporte ao navegador
Os portais integrados da Apigee são compatíveis com as mesmas versões de navegador do Apigee Edge.