Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
A Apigee oferece um portal integrado e fácil de usar para documentar e gerir o acesso às suas APIs, e fomentar a sua comunidade de programadores de apps.
Todos os utilizadores do Apigee têm acesso às ferramentas de desenvolvimento de portais integradas, o que lhes permite criar rapidamente o seu próprio portal do programador, oferecendo uma alternativa ao desenvolvimento de portais baseados no Drupal. Para uma comparação de funcionalidades, consulte o artigo Comparação das funcionalidades do portal para programadores.
Principais funcionalidades e vantagens
O portal integrado oferece as seguintes principais funcionalidades e vantagens:| Funcionalidade | Vantagens |
|---|---|
| Desenvolvimento de conteúdo do portal | Desenvolva o conteúdo do seu portal de forma rápida e fácil.
|
| Aspeto e funcionalidade do portal | Personalize totalmente o aspeto e a funcionalidade do seu portal através de folhas de estilo SCSS e branding personalizado. |
| Documentação da API | Gere automaticamente documentação de referência da API com base nas suas especificações da OpenAPI. |
| Registo self-service | Oferecer registo self-service para os programadores criarem apps através das suas APIs. |
| Gestão de públicos-alvo | Controle quem pode aceder ao conteúdo e às APIs do portal |
| Google Analytics | Configure o Google Analytics e o acompanhamento de estatísticas personalizado. |
| Personalizações avançadas | Realizar personalizações avançadas do portal, incluindo:
|
Como o Apigee aborda a segurança no portal integrado
A tabela seguinte descreve como o Apigee aborda a segurança através de funcionalidades incorporadas no portal integrado.
| Funcionalidade | Moradas |
|---|---|
| Requer HTTPS e Transport Layer Security (TLS) | Aplica a comunicação encriptada |
Inclui o apigee.ioregisto de domínio com a lista de sufixos públicos
|
Impede a definição de "supercookies" em subdomínios de apigee.io
|
Requer:
|
Protege contra ataques de injeção de HTML, SQL ou backend |
Inclui cabeçalho x-content-type-options: nosniff XSS
|
Impede que os navegadores tentem adivinhar os tipos MIME |
Inclui cabeçalho x-frame-options: deny XSS
|
Não permite a incorporação de conteúdo do portal numa iFrame |
Inclui cabeçalho x-xss-protection: 1 XSS
|
Impede o carregamento de páginas quando detetam ataques de cross-site scripting (XSS) refletidos |
| Utiliza tokens CSRF | Protege contra falsificação em pedidos entre sites |
Tira partido:
|
Proteções de dados de clientes |
Como o portal integrado comunica com o Apigee
A maioria das informações usadas pelo portal do programador é armazenada no Apigee. O portal funciona como um cliente do Apigee. Conforme necessário, o portal do programador envia um pedido REST HTTP ou HTTPS para obter informações do Apigee ou enviar informações para o mesmo. Por exemplo, quando um utilizador do portal regista uma nova app no portal, o portal envia um pedido ao Apigee para armazenar informações sobre a app.
As secções seguintes fornecem mais detalhes.
Onde são armazenados o registo de apps e as chaves da API
Quando um utilizador do portal conclui o processo de registo da app no portal integrado, o portal envia informações sobre a app para o Apigee, incluindo o nome da app e os produtos de API associados à app. Se o Apigee registar a app com êxito, devolve uma única chave de API ao portal. O utilizador do portal usa essa chave da API para aceder aos produtos da API associados à app.
As informações sobre as apps e as chaves de API são armazenadas apenas no Apigee e não no portal. Quando um utilizador do portal usa o portal para ver informações sobre uma app, por exemplo, através da página As minhas apps, o portal faz um pedido ao Apigee com a chave de API para aceder às informações.
Da mesma forma, quando um utilizador do portal adiciona, remove ou modifica uma app, o portal envia as modificações para o Apigee para serem armazenadas.
Uma vez que todas as informações sobre as apps e as chaves de API são armazenadas no Apigee, um administrador do Apigee pode modificar as informações através da IU do Apigee ou da API de gestão. Por exemplo, um administrador pode:
- Adicione, remova ou modifique uma app de programador
- Aprove ou revogue uma chave da API para uma app de programador
Para mais informações, consulte o artigo Controlar o acesso às suas APIs através do registo de apps.
Onde são armazenadas as informações da conta de programador de apps
As informações da conta de programador são armazenadas no Apigee, da seguinte forma:
- Quando um utilizador do portal cria uma conta através do fornecedor de identidade incorporado, as informações são armazenadas no fornecedor de identidade e apresentadas na página Utilizadores.
- Quando um utilizador do portal inicia sessão no portal através do fornecedor de identidade SAML, é armazenado um registo oculto das informações no fornecedor de identidade e apresentado na página Utilizadores.
- Depois de um utilizador do portal registar uma app de programador, as informações da conta de utilizador são sincronizadas e ficam disponíveis no Apigee na página Developers.
As seguintes informações da conta de utilizador são armazenadas no Apigee:
- Nome próprio e apelido
- Endereço de email
- Nome de utilizador
- Estado da conta do portal (ativa ou inativa)
- Função do portal (utilizador autenticado, administrador, outro)
- Autorizações com base em funções
- Equipas das quais o utilizador do portal é membro (se tiver inscrito na versão de pré-visualização da funcionalidade de equipas)
O endereço de email é a chave principal usada pelo Apigee para identificar o programador e cada um tem de ser exclusivo. A partir da chave principal, o Apigee gera um ID de programador exclusivo para cada organização à qual o programador pertence.
Para mais informações, consulte o artigo Registe programadores de apps.
Onde são armazenadas as informações da equipa de programadores (pré-visualização)
Quando uma equipa de programadores é criada no portal por um utilizador do portal, as informações da equipa de programadores são armazenadas no Apigee, incluindo:
- Nome e descrição da equipa de programadores
- Membros da equipa de programadores e respetivas funções
- Apps às quais a equipa de programadores está atribuída
- Públicos-alvo atribuídos à equipa de programadores
- Hora em que a equipa de programadores foi criada
É gerado um endereço de email único e gerado automaticamente para a equipa de programadores, que serve como chave principal usada pelo Apigee para identificar a equipa de programadores.
Para mais informações, consulte os artigos Partilhe a responsabilidade por uma app através de equipas de programadores (pré-visualização) e Faça a gestão de equipas de programadores.
Acerca do portal de amostra
Quando cria um novo portal, é-lhe disponibilizado um conjunto de páginas iniciais para usar como ponto de partida. As páginas iniciais contêm conteúdo de demonstração para ajudar a inspirar o seu próprio desenvolvimento de portal à medida que substitui o texto e as imagens pelo seu conteúdo único. O tema do portal de exemplo usa temas de design de materiais e SCSS.
A imagem seguinte mostra a página inicial do portal de exemplo.
As páginas iniciais fornecidas com o portal de exemplo incluem:
| Página | Descrição |
|---|---|
| Página inicial | Página inicial do portal que descreve as APIs apresentadas. Funciona como página inicial predefinida para o seu portal (index.html). Demonstra a utilização de componentes do angular material, conforme descrito em Adicione componentes do angular material. |
| Começar | Página de conteúdo de exemplo. Saiba como editar esta página e adicioná-la à navegação superior seguindo o tutorial. |
| APIs | Lista de APIs disponíveis. Quando gera documentação de referência da API interativa, os links para o conteúdo são adicionados automaticamente a esta página. Nota: o conteúdo desta página é gerado automaticamente com base nas APIs que publica no seu portal. Não pode editar o conteúdo desta página diretamente. Esta não aparece na lista de páginas. Pode modificar o estilo da página através do editor de temas do portal. |
| As minhas aplicações | Lista de apps registadas para um utilizador autorizado. Veja Como os utilizadores do portal interagem com o seu portal. Nota: o conteúdo desta página é gerado automaticamente com base nas apps de utilizadores registados. Não pode editar o conteúdo da página diretamente. Esta não aparece na lista de páginas. Pode modificar o estilo da página através do editor de temas. |
| Iniciar sessão | Página de início de sessão para utilizadores registados. Os novos utilizadores podem registar-se a partir desta página clicando em Criar conta. Consulte o artigo Como os utilizadores do portal interagem com o seu portal. Nota: a página de início de sessão é incluída automaticamente no seu portal. Pode personalizar o logótipo na página de início de sessão e adicionar campos de registo personalizados à página de criação de conta. Não pode editar o conteúdo da página diretamente. Esta não aparece na lista de páginas. " |
| Termos de Utilização | Página de termos de utilização de exemplo. |