Como os utilizadores do portal interagem com o seu portal

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

O portal do programador permite, de imediato, que os utilizadores do portal criem uma conta de utilizador, iniciem sessão e façam a gestão das apps que vão consumir as suas APIs.

As secções seguintes descrevem como os utilizadores do portal interagem com o seu portal.

Iniciar sessão no portal

As secções seguintes descrevem como os utilizadores do portal iniciam sessão no portal integrado através das respetivas credenciais de utilizador (fornecedor de identidade incorporado) ou através de SAML (pré-visualização).

Se ativar os fornecedores de identidade incorporados e SAML, os utilizadores do portal podem escolher o respetivo método preferido para iniciar sessão.

Iniciar sessão no portal com credenciais de utilizador (fornecedor de identidade incorporado)

Nota: não é possível editar a página de início de sessão, exceto para alterar o logótipo da empresa, conforme descrito no artigo Configure a experiência de início de sessão e criação de contas de utilizador.

Quando o fornecedor de identidade integrado está ativado, os utilizadores do portal podem iniciar sessão no portal integrado através das respetivas credenciais de utilizador (nome de utilizador e palavra-passe), conforme descrito nas secções seguintes:

• Crie uma conta de utilizador no portal integrado
• Inicie sessão no portal integrado
• Altere a palavra-passe

Criar uma conta de utilizador no portal integrado

Com o fornecedor de identidade incorporado, antes de os utilizadores do portal poderem usar as suas APIs, têm de criar uma conta de utilizador no portal integrado.

Ponto-chave: veja também o artigo Onde são armazenadas as informações da conta de programador de apps.

Embora seja possível criar manualmente contas de utilizador em nome dos utilizadores do portal através da IU do Apigee, conforme descrito no artigo Registar programadores de apps, isto não é recomendado para garantir que as contas de utilizador no portal integrado e os registos de programadores no Apigee permanecem sincronizados.

Os utilizadores do portal criam uma conta no portal integrado da seguinte forma:

1. Navegue para o portal.

2. Clique em Iniciar sessão.

   É apresentada a página de início de sessão.

3. Clique em Criar conta.

   É apresentada a página Crie a sua conta.

   

   Nota: pode adicionar campos de registo personalizados à página de criação de conta, conforme descrito no artigo Adicionar campos de registo personalizados à página de criação de conta.

4. Preencha o formulário.

   Tem de introduzir valores para todos os campos obrigatórios. As palavras-passe têm de ter, pelo menos, 8 carateres e conter, pelo menos, um de cada um dos seguintes elementos: número, letra minúscula, letra maiúscula e caráter especial.

5. Reveja e aceite os termos.

6. Clique em Criar conta.

   Nota: se for feita uma tentativa de criar uma conta com um ID de email que já tenha sido registado, é apresentada uma mensagem a indicar que a conta já existe e o utilizador do portal é incentivado a iniciar sessão.

7. Preencha o formulário CAPTCHA e clique em Validar (se apresentado).

   A conta de utilizador é criada e é enviado um email de confirmação.

   Nota: pode configurar o email de confirmação, conforme descrito em Configurar notificações por email. A Apigee recomenda que configure o servidor SMTP usado para as notificações por email provenientes do portal antes do lançamento, conforme descrito em Configurar o servidor SMTP.

8. No prazo de 10 minutos, clique no link no email de confirmação para concluir o processo de registo.

   Se não clicar no link no prazo de 10 minutos, tem de repetir os passos neste procedimento para criar uma conta e receber novamente o pedido.

9. Inicie sessão no portal integrado (descrito abaixo).

Iniciar sessão no portal integrado

Com o fornecedor de identidade incorporado, depois de os utilizadores do portal se registarem no portal integrado e serem aprovados, iniciam sessão com as respetivas credenciais (nome de utilizador e palavra-passe).

Notas:

• Após 24 horas de inatividade, a sessão expira, e o utilizador do portal termina sessão automaticamente e tem de iniciar sessão novamente.
• Se configurou o seu portal integrado para exigir a ativação manual das contas de utilizador, tem de ativar manualmente as contas de utilizador antes de os utilizadores do portal poderem iniciar sessão. Neste momento, os utilizadores do portal não recebem nenhuma indicação de que o respetivo registo tem de ser ativado manualmente antes de poderem iniciar sessão. Recomendamos que, se configurar a ativação manual, acelere a ativação das novas contas de utilizador.
• Para navegar diretamente para a página de início de sessão, use o seguinte URL:
  https://portal-url/login

Os utilizadores do portal iniciam sessão da seguinte forma:

1. Navegue para o portal.

2. Clique em Iniciar sessão. A página de início de sessão apresenta:

   

3. Introduza o endereço de email e a palavra-passe.

4. Clique em Iniciar sessão.

Alterar a palavra-passe

Com o fornecedor de identidade incorporado, os utilizadores do portal alteram a palavra-passe da seguinte forma:

1. Navegue para o portal.
2. Clique em Iniciar sessão.
3. Clique em Repor palavra-passe.
4. Introduza o endereço de email da conta a repor.

5. Clique em Enviar link para repor palavra-passe.

   É enviado um link de reposição de palavra-passe para o email.

   Nota: para configurar o servidor SMTP, consulte o artigo Configurar o servidor SMTP.

6. Clique no link no email de confirmação.

7. Introduza a nova palavra-passe e confirme-a.

   As palavras-passe têm de ter, pelo menos, 8 carateres e conter, pelo menos, um de cada um dos seguintes elementos: número, letra minúscula, letra maiúscula e caráter especial.

8. Clique em Criar nova palavra-passe.

Iniciar sessão no portal através da autenticação SAML (pré-visualização)

Nota: esta é a versão de pré-visualização do fornecedor de identidade SAML.

Nota: não é possível editar a página de início de sessão, exceto para alterar o logótipo da empresa, conforme descrito no artigo Configure a experiência de início de sessão e criação de contas de utilizador.

Quando o fornecedor de identidade SAML está ativado, os utilizadores do portal iniciam sessão no portal integrado através da autenticação SAML, da seguinte forma:

1. Navegue para o portal.
2. Clique em Iniciar sessão.

3. Clique em Iniciar sessão com SAML.

   É feito o redirecionamento para o fornecedor de SAML.

4. Se lhe for pedido, introduza as suas credenciais para o fornecedor de identidade SAML.

Nota: após 24 horas de inatividade, a sessão expira, e o utilizador do portal termina sessão automaticamente e tem de iniciá-la novamente.

Ver documentação de referência da API

Os utilizadores do portal podem ver a documentação de referência da API que publicou no seu portal da seguinte forma:

1. Navegue para o portal.

2. Clique em APIs na barra de navegação superior. É apresentada a página APIs. Por exemplo:
   
   

3. Se quiser, filtre a lista de APIs por categoria, título ou descrição através das ferramentas no painel esquerdo.

4. Clique num cartão da API para ver a documentação de referência da API. É apresentada a documentação de referência da API.

Os utilizadores do portal podem saber mais sobre as APIs e experimentá-las, ou transferir o documento usado para renderizar a documentação de referência da API. Consulte o artigo Publicar as suas APIs para mais informações sobre como a documentação de referência da API é renderizada.

Partilhar a responsabilidade por uma app através de equipas de programadores (pré-visualização)

Nota: tem de ter inscrito na versão de pré-visualização da funcionalidade de equipas.

As equipas de programadores permitem que os utilizadores do portal partilhem a responsabilidade por uma app com outros utilizadores do portal. As secções seguintes descrevem como criar e gerir equipas de programadores.

Ponto-chave: as equipas de programadores são denominadas simplesmente "equipas" quando navega no portal do programador.

Acerca das funções da equipa de programação

A tabela seguinte resume as funções que podem ser atribuídas aos membros da equipa de programadores:

Nota: enquanto membro da equipa de programadores, pode remover-se de qualquer equipa de programadores, independentemente da sua função, a menos que seja proprietário da equipa de programadores.

Função	Descrição
Administrador da app	Privilégios só de leitura para membros da equipa de programadores e detalhes da equipa de programadores. Privilégios de leitura e escrita para apps.
Proprietário	Privilégios de leitura e escrita completos para os membros da equipa de programadores, os detalhes da equipa de programadores e as apps.
Leitor	Privilégios só de leitura para membros da equipa de programadores, detalhes da equipa de programadores e apps.

Ver a página Equipas

A página Equipas apresenta as equipas de programadores das quais é membro.

Para aceder à página Equipas:

1. Inicie sessão no portal.
2. Selecione Equipas no menu pendente da conta de utilizador no portal.

É apresentada a página Equipas, que lhe permite:

• Veja as equipas de programadores das quais é membro, incluindo o nome, a função, a lista de membros e a data de criação da equipa
• Adicione uma equipa de programadores
• Editar a adesão e as funções da equipa de programadores, remover-se de uma equipa de programadores ou eliminar uma equipa clicando na linha da equipa de programadores

Adicionar equipas de programadores

Nota: os utilizadores do portal podem ver as equipas de programadores das quais são membros na página Equipas. Para a versão de pré-visualização, não são enviadas notificações quando um utilizador do portal é adicionado a uma equipa de programadores.

Para adicionar uma equipa de programadores:

1. Inicie sessão no portal.
2. Selecione Equipas no menu pendente da conta de utilizador no portal.
3. Clique em + Nova equipa.
4. Introduza um nome e uma descrição.

5. Para adicionar um membro à equipa de programadores, clique em + Adicionar outro membro, introduza o endereço de email do utilizador do portal e selecione uma função da equipa de programadores.

   Repita o processo para adicionar mais membros.

   Nota:

   • É adicionado automaticamente como proprietário da equipa de programadores.
   • O número máximo de equipas de programadores das quais um utilizador pode ser membro é 16.

6. Para eliminar um membro da equipa de programadores, clique em junto ao membro da equipa de programadores que quer eliminar.

7. Clique em Criar.

Editar a associação e as funções da equipa de programadores

Para editar a associação e as funções da equipa de programadores:

1. Inicie sessão no portal.
2. Selecione Equipas no menu pendente da conta de utilizador no portal.
3. Clique na linha da equipa de programadores que quer editar e da qual é proprietário.

4. Realize um ou mais dos seguintes passos:

   • Edite o nome, a descrição e o contacto principal.
   • Adicione ou remova membros da equipa de programadores.
   • Atualize as funções dos membros da equipa de programadores.
     Nota:

     • Uma equipa de programadores tem de ter, pelo menos, um proprietário.
     • O número máximo de equipas de programadores das quais um utilizador pode ser membro é 16.

5. Clique em Guardar.

Remover-se de uma equipa de programadores

Nota: enquanto membro da equipa de programadores, pode remover-se de qualquer equipa de programadores, independentemente da sua função na equipa de programadores, a menos que seja proprietário da equipa de programadores.

Para se remover de uma equipa de programadores:

1. Inicie sessão no portal.
2. Selecione Equipas no menu pendente da conta de utilizador no portal.
3. Clique na linha da equipa de programadores da qual quer remover a sua conta.
4. Clique em Sair da equipa.

Eliminar uma equipa de programadores

Nota: quando elimina uma equipa de programadores, todas as apps pertencentes à equipa de programadores são eliminadas.

Para eliminar uma equipa de programadores:

1. Inicie sessão no portal.
2. Selecione Equipas no menu pendente da conta de utilizador no portal.
3. Clique na linha da equipa de programadores que quer eliminar.
4. Clique em .
5. Clique em Confirmar para confirmar a eliminação.

Registar apps

Registe apps de programador e apps da equipa de programadores, conforme descrito nas secções seguintes.

Registar apps de programadores

Ponto-chave: depois de o 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. Consulte o artigo Onde são armazenadas as informações da conta de programador de apps.

Os utilizadores do portal podem registar apps para usar as APIs que publicou, da seguinte forma:

1. No portal, selecione Apps no menu pendente da conta de utilizador.
2. Clique em + Nova app para criar uma nova app.
3. Introduza um nome e uma descrição para a app na caixa de diálogo Nova app.

4. Na secção APIs, ative uma ou mais APIs.

   As APIs no catálogo estão categorizadas como APIs autenticadas, que requerem um URL de retorno de chamada, ou APIs públicas. Tem de selecionar, pelo menos, uma API para criar uma app.

5. Se selecionar uma API na secção APIs autenticadas, introduza um URL de retorno de chamada.

   Para mais informações, consulte o artigo Acerca dos URLs de retorno de chamada.

6. Clique em Guardar.

Registar apps da equipa de programadores

Nota: este passo só se aplica se tiver inscrito na versão de pré-visualização da funcionalidade de equipas. Na pré-visualização, não é possível transferir a propriedade da app após a criação da mesma.

Os membros da equipa de programadores podem registar apps para uma equipa de programadores usar as APIs que publicou, conforme descrito abaixo.

Nota: uma nova entidade de equipa de programadores é adicionada ao Apigee apenas depois de um membro registar uma app para a equipa. Consulte o artigo Onde são armazenadas as informações da equipa de programadores (pré-visualização).

Para saber como:

• Os utilizadores do portal adicionam e gerem equipas, conforme descrito no artigo Partilhar responsabilidade por uma app através de equipas de programadores (pré-visualização).
• Os fornecedores de APIs veem e gerem equipas de programadores, conforme descrito no artigo Gerir equipas de programadores (pré-visualização).

Para registar apps da equipa de programadores:

1. Selecione Equipas no menu pendente da conta de utilizador.
2. Clique na linha da equipa de programadores para a qual quer registar uma app.
3. Clique em + Nova app para criar uma nova app.
4. Introduza um nome e uma descrição para a app na caixa de diálogo Nova app.

5. Selecione o proprietário da app na lista pendente Proprietário.

   Por predefinição, a equipa de programadores é a proprietária da app. Se quiser, selecione uma equipa de programadores diferente ou a si próprio como proprietário no menu pendente.

   Nota: na versão de pré-visualização, não é possível transferir a propriedade da app depois de a criar.

6. Na secção Catálogo de APIs, ative uma ou mais APIs.

   As APIs no catálogo estão categorizadas como APIs autenticadas, que requerem um URL de retorno de chamada, ou APIs públicas. Tem de selecionar, pelo menos, uma API para criar uma app.

7. Se selecionar uma API na secção APIs autenticadas, introduza um URL de retorno de chamada.

   Para mais informações, consulte o artigo Acerca dos URLs de retorno de chamada.

8. Clique em Guardar.

Gerir as APIs numa app

Enquanto produtor de APIs, publica APIs para permitir que os utilizadores do portal consumam os seus produtos de API.

Os utilizadores do portal gerem as APIs que as respetivas apps usam. As APIs são adicionadas à página de detalhes da app. Para algumas APIs, a aprovação não é automática. O estado Aprovação pendente indica uma API para a qual o acesso foi pedido, mas ainda não foi concedido.

Nota: atualmente, as APIs não publicadas não são apresentadas. Este problema vai ser corrigido numa versão futura.

Se o utilizador do portal desativar o acesso a uma API que seja apenas privada ou interna, a API é removida da app e tem de ser adicionada novamente manualmente pelo administrador do portal, conforme descrito no artigo Controlar o acesso às suas APIs através do registo de apps.

Os utilizadores do portal podem gerir as APIs numa app a partir do seu portal, da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique na app na lista.
3. Na secção APIs, clique em Ativar ou Desativar acesso para adicionar ou remover uma API da app.
4. Para uma API autenticada, adicione ou edite o URL de retorno de chamada, conforme necessário.
5. Clique em Guardar.

Ver a chave da API e o segredo de uma app

Os utilizadores do portal podem gerir a chave da API de uma app a partir do seu portal, da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique na app na lista.
3. Veja as chaves da API na secção Chaves da API.
4. Confirme se o estado da chave da API é Ativo. Se a sua chave da API exigir aprovação e ainda não tiver sido aprovada, o estado é apresentado como Aprovação pendente.
5. Clique em Mostrar segredo para ver o segredo.
6. Posicione o cursor sobre a chave da API ou o segredo e clique em para o copiar para a área de transferência.

Nota: se a conta de utilizador ou a app tiver sido desativada/revogada, a chave de API não é válida até que a conta de utilizador ou a app seja reativada/reaprovada. Para mais informações, consulte os artigos Ativar e desativar um programador e Aprovar ou revogar uma app.

Alternar a chave da API para uma app

Um utilizador do portal pode rodar periodicamente a chave da API de uma app ou em resposta a uma potencial fuga ou comprometimento. Quando um utilizador do portal roda uma chave da API, é criada uma nova chave da API com as mesmas autorizações da API que a chave original. A chave da API original permanece ativa enquanto a desativa. Tem de revogar a chave da API antiga para impedir que as respetivas credenciais sejam aceites, conforme descrito no artigo Revogar uma chave da API para uma app.

Os utilizadores do portal podem rodar uma chave de API para uma app a partir do seu portal, da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique na app na lista.
3. Na secção Chaves da API, clique em Adicionar chave.
4. Clique em Confirmar na caixa de diálogo para confirmar a operação.
5. Opcionalmente, revogue a chave da API antiga, conforme descrito abaixo.

Revogar uma chave da API para uma app

Quando um utilizador do portal roda uma chave de API, conforme descrito na secção anterior, a chave de API permanece ativa enquanto a retira de utilização. Tem de revogar uma chave da API para impedir que as respetivas credenciais sejam aceites.

Os utilizadores do portal podem revogar uma chave da API para uma app a partir do seu portal, da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique no nome da app.
3. Na secção Chaves da API, clique em Revogar na coluna Ações associada à chave da API que quer revogar.

4. Clique em Confirmar para confirmar a operação.

   O estado da chave é atualizado para Revogado.

Editar detalhes da app

Os utilizadores do portal podem editar os detalhes da app da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique na app na lista.
3. Edite os campos Nome ou Descrição no separador Detalhes da app.
4. Gerir as APIs numa app, conforme necessário.
5. Clique em Guardar.

Eliminar uma app

Os utilizadores do portal podem eliminar uma app do seu portal da seguinte forma:

1. Selecione Apps no menu pendente da conta de utilizador.
2. Clique na app na lista.
3. Clique em ELIMINAR.
4. Clique em Confirmar para confirmar a operação.

A app é eliminada e removida da lista de apps.