Como os usuários do portal interagem com seu portal

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

O portal do desenvolvedor é um portal pronto para uso que permite aos usuários criar uma conta de usuário, fazer login e gerenciar os apps que consumirão suas APIs.

As seções a seguir descrevem como os usuários do portal interagem com ele.

Como fazer login no portal

As seções a seguir descrevem como os usuários do portal fazem login no portal integrado usando suas credenciais de usuário (provedor de identidade integrado) ou SAML (Beta).

Se você ativar os provedores de identidade integrados e SAML, os usuários do portal poderão escolher o método preferido de login.

Como fazer login no portal usando credenciais de usuário (provedor de identidade integrado)

Observação: a página de login não pode ser editada a não ser para alterar o logotipo da empresa, conforme descrito em Configurar a criação e a experiência de login da conta do usuário.

Quando o provedor de identidade integrado está ativado, os usuários do portal podem fazer login no portal integrado usando as credenciais do usuário (nome de usuário e senha), conforme descrito nas seções a seguir:

• Criar uma conta de usuário no portal integrado
• Fazer login no portal integrado
• Alterar a senha

Criar uma conta de usuário no portal integrado

Com o provedor de identidade integrado, para que os usuários do portal possam usar suas APIs, eles precisam criar uma conta de usuário no portal integrado.

Importante: consulte também Onde as informações da conta de desenvolvedor do app são armazenadas.

Embora seja possível criar contas de usuário em nome dos usuários do portal manualmente usando a IU de gerenciamento do Edge, conforme descrito em Como registrar desenvolvedores de apps, isso não é recomendado para garantir que as contas de usuário do portal integrado e os registros do desenvolvedor no Edge permanecem sincronizados.

Os usuários do portal criam uma conta no portal integrado da seguinte forma:

1. Navegue até o portal.

2. Clique em Fazer login.

   A página de login é exibida.

3. Clique em Criar conta.

   A página "Criar sua conta" é exibida.

   

   Observação: é possível adicionar campos de registro personalizados à página de criação da conta, conforme descrito em Adicionar campos de registro personalizados à página de criação da conta.

4. Preencha o formulário.

   Insira valores para todos os campos obrigatórios. As senhas precisam ter no mínimo oito caracteres e conter pelo menos um dos seguintes itens: número, letra minúscula, letra maiúscula e caractere especial.

5. Leia e concorde com os termos.

6. Clique em Criar conta.
   

   Observação: se for feita uma tentativa de criar uma conta com um ID de e-mail que já tenha sido registrado, uma mensagem aparecerá indicando que a conta já existe e o usuário do portal será recomendado a fazer login.
   1. Preencha o formulário CAPTCHA e clique em Verificar (se exibido).

   A conta de desenvolvedor é criada e um e-mail de confirmação é enviado.

   Observação: é possível configurar o e-mail de confirmação conforme descrito em Como configurar notificações por e-mail. A Apigee recomenda que você configure o servidor SMTP para as notificações por e-mail provenientes do portal antes do lançamento, conforme descrito em Como configurar o servidor SMTP.

7. Em 10 minutos, clique no link no e-mail de confirmação para concluir o processo de registro.

   Se você não clicar no link em 10 minutos, precisará repetir as etapas deste procedimento para criar uma conta e ser solicitado novamente.

8. Faça login no portal integrado (descrito abaixo).

Como fazer login no portal integrado

Com o provedor de identidade integrado, depois que os usuários do portal forem registrados no portal integrado e aprovados, eles farão login usando suas credenciais (nome de usuário e senha).

Observações:

• Após 24 horas de inatividade, a sessão expirará, e o usuário do portal será desconectado automaticamente e precisará fazer login novamente.
• Se você tiver configurado seu portal integrado para exigir a ativação manual das contas de usuário, precisará ativar as contas de usuário manualmente para que os usuários do portal possam fazer login. No momento, os usuários do portal não recebem nenhum indicador de que o registro precisa ser ativado manualmente antes de fazer login. Se você configurar a ativação manual, recomendamos que você agilize a ativação das novas contas de desenvolvedor.
• Para navegar diretamente até a página de login, use o seguinte URL:
  https://portal-url/login

Os usuários do Portal fazem login da seguinte maneira:

1. Navegue até o portal.
2. Clique em Sign In.
   A página de login é exibida:
   
3. Digite o endereço de e-mail e a senha.
4. Clique em Fazer login.

Como alterar a senha

Com o provedor de identidade interno, os usuários do portal alteram a senha da seguinte maneira:

1. Navegue até o portal.
2. Clique em Fazer login.
3. Clique em Redefinir senha.
4. Digite o endereço de e-mail da conta que será redefinida.

5. Clique em Enviar link de redefinição de senha.

   Um link de redefinição de senha é enviado para o e-mail.

   Observação: para configurar o servidor SMTP, consulte Como configurar o servidor SMTP.

6. Clique no link no e-mail de confirmação.

7. Digite a nova senha e confirme.

   As senhas precisam ter no mínimo oito caracteres e conter pelo menos um dos seguintes itens: número, letra minúscula, letra maiúscula e caractere especial.

8. Clique em Criar nova senha.

Como fazer login no portal usando a autenticação SAML (Beta)

Observação: esta é a versão Beta do provedor de identidade SAML.

Observação: a página de login não pode ser editada a não ser para alterar o logotipo da empresa, conforme descrito em Configurar a criação e a experiência de login da conta do usuário.

Quando o provedor de identidade SAML estiver ativado, os usuários do portal farão login no portal integrado usando a autenticação SAML da seguinte forma:

1. Navegue até o portal.
2. Clique em Fazer login.

3. Clique em Fazer login com SAML.

   Você será redirecionado para o provedor SAML.

4. Se solicitado, insira as credenciais do provedor de identidade SAML.

Observação: após 24 horas de inatividade, a sessão expirará, e o usuário do portal será desconectado automaticamente e precisará fazer login novamente.

Como visualizar a documentação de referência da API

Os usuários do Portal podem visualizar a documentação de referência da API que você publicou no seu portal da seguinte maneira:

1. Navegue até o portal.

2. Clique em APIs na barra de navegação superior.
   A página "APIs" é exibida. Por exemplo:
   
   

3. Filtre a lista de APIs por categoria, título ou descrição, se quiser, usando as ferramentas do painel esquerdo.

4. Clique em um cartão de API para visualizar a documentação de referência da API.
   A documentação de referência da API é exibida.

Os usuários do portal podem conhecer e testar as APIs ou fazer o download do documento usado para renderizar a documentação de referência da API. Consulte Publicar APIs para mais informações sobre como a documentação de referência da API é renderizada.

Como compartilhar a responsabilidade por um app usando equipes de desenvolvedores (Beta)

Observação: é necessário estar inscrito na versão Beta do recurso de equipes.

As equipes de desenvolvedores permitem que os usuários do portal compartilhem a responsabilidade por um app com outros usuários do portal. As seções a seguir descrevem como criar e gerenciar equipes de desenvolvedores.

Importante: as equipes de desenvolvedores são simplesmente chamadas de "equipes" ao navegar no portal do desenvolvedor.

Sobre os papéis da equipe de desenvolvedores

A tabela a seguir resume os papéis que podem ser atribuídas aos membros da equipe de desenvolvedores:

Observação: o membro da equipe de desenvolvedores pode remover a si mesmo de qualquer equipe de desenvolvedores, independentemente do papel, a menos que seja o proprietário.

Papel	Descrição
Administrador do app	Privilégios somente leitura para membros e detalhes da equipe de desenvolvedores. Privilégios de leitura e gravação de apps.
Proprietário	Privilégios completos de leitura e gravação para membros da equipe de desenvolvedores, detalhes da equipe de desenvolvedores e apps.
Visualizador	Privilégios somente leitura para membros da equipe de desenvolvedores, detalhes da equipe de desenvolvedores e apps.

Como visualizar a página "Equipes"

A página "Equipes" exibe as equipes de desenvolvedores de que você faz parte.

Para acessar a página "Equipes", siga estas etapas:

1. Faça login no portal.
2. Selecione Equipes na lista suspensa de contas de usuário no portal.

A página "Equipes" é exibida e permite:

• ver as equipes de desenvolvedores de que você é membro, incluindo o nome, o papel, a lista de participantes e a data em que a equipe foi criada;
• adicionar uma equipe de desenvolvedores ;
• editar a assinatura e os papéis da equipe de desenvolvedores, remover a si mesmo de uma equipe de desenvolvedores ou excluir uma equipe clicando na linha da equipe de desenvolvedores.

Como adicionar equipes de desenvolvedores

Observação: os usuários do portal podem ver as equipes dos desenvolvedores de que são membros na página "Equipes". Na versão Beta, não é enviada nenhuma notificação quando um usuário do portal é adicionado a uma equipe de desenvolvedores.

Para adicionar uma equipe de desenvolvedores, siga estas etapas:

1. Faça login no portal.
2. Selecione Equipes na lista suspensa de contas de usuário no portal.
3. Clique em + Nova equipe.
4. Digite um nome e uma descrição.

5. Para adicionar um membro à equipe de desenvolvedores, clique em + Adicionar outro membro, digite o endereço de e-mail do usuário do portal e selecione um papel da equipe de desenvolvedores.

   Repita o processo para adicionar outros membros.

   Observação:

   • Você é adicionado automaticamente como proprietário da equipe de desenvolvedores.
   • Um usuário pode ser membro de até 16 equipes de desenvolvedores.

6. Para excluir um membro da equipe de desenvolvedores, clique no ao lado do membro que você quer excluir.

7. Clique em Criar.

Como editar a assinatura e os papéis da equipe de desenvolvedores

Para editar os membros e os papéis da equipe de desenvolvedores, siga estes passos:

1. Faça login no portal.
2. Selecione Equipes na lista suspensa de contas de usuário no portal.
3. Clique na linha da equipe de desenvolvedores que você quer editar e de que é um proprietário.

4. Execute uma ou mais destas etapas:

   • Edite o nome, a descrição e o contato principal.
   • Adicione ou remova membros da equipe de desenvolvedores.
   • Atualize os papéis dos membros da equipe de desenvolvedores.
     Observação:

     • Uma equipe de desenvolvedores precisa ter pelo menos um proprietário.
     • Um usuário pode ser membro de até 16 equipes de desenvolvedores.

5. Clique em Save.

Como remover a si mesmo de uma equipe de desenvolvedores

Observação: como membro da equipe de desenvolvedores, você pode se remover de qualquer equipe de desenvolvedor, independentemente do papel da equipe de desenvolvedores, a menos que você seja um proprietário da equipe.

Para sair de uma equipe de desenvolvedores, siga estas etapas:

1. Faça login no portal.
2. Selecione Equipes na lista suspensa de contas de usuário no portal.
3. Clique na linha da equipe de desenvolvedores da qual você quer sair.
4. Clique em Sair da equipe.

Como excluir uma equipe de desenvolvedores

Observação: quando você exclui uma equipe de desenvolvedores, todos os apps da equipe são excluídos.

Para excluir uma equipe de desenvolvedores, siga estas etapas:

1. Faça login no portal.
2. Selecione Equipes na lista suspensa de contas de usuário no portal.
3. Clique na linha da equipe de desenvolvedores que você quer excluir.
4. Clique em .
5. Clique em Confirmar para fazer a exclusão.

Como registrar apps

Registre os aplicativos de desenvolvedor e os aplicativos da equipe de desenvolvedores, conforme descrito nas seções a seguir.

Como registrar apps de desenvolvedor

Importante: depois que o usuário do portal registrar um app de desenvolvedor, as informações da conta de usuário serão sincronizadas e estarão disponíveis no Edge na página "Desenvolvedores". Consulte Onde as informações da conta de desenvolvedor de apps são armazenadas.

Os usuários do portal podem registrar apps para usar as APIs publicadas da seguinte maneira:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique em + Novo aplicativo para criar um novo aplicativo.
3. Insira um nome e uma descrição para o aplicativo na caixa de diálogo "Novo aplicativo".

4. Na seção "Catálogo de APIs", selecione uma ou mais APIs.

   As APIs no catálogo são categorizadas como APIs autenticadas, exigindo um URL de retorno de chamada ou APIs públicas. É preciso selecionar pelo menos uma API para criar um app.

5. Se você selecionar uma API na seção "APIs autenticadas", insira um URL de callback.

   Para mais informações, consulte Sobre URLs de callback.

6. Clique em Criar.

Como registrar apps de equipes de desenvolvedores

Observação: essa etapa será aplicável somente se você tiver inscrito na versão Beta do recurso de equipes. Na versão Beta, a propriedade do app não pode ser transferida após a criação do app.

Os membros da equipe de desenvolvedores podem registrar apps de uma equipe de desenvolvedores para usar as APIs que você publicou, conforme descrito abaixo.

Observação: uma nova entidade da equipe de desenvolvedores será adicionada ao Edge somente depois que um membro registrar um app da equipe. Consulte Onde as informações da equipe do desenvolvedor são armazenadas (Beta).

Para saber mais sobre como:

• os usuários do portal adicionam e gerenciam equipes, conforme descrito em Como compartilhar a responsabilidade por um aplicativo usando equipes de desenvolvedores (Beta);
• os provedores de API visualizam e gerenciam equipes de desenvolvedores, conforme descrito em Como gerenciar equipes de desenvolvedores (Beta).

Para registrar apps da equipe de desenvolvedores, siga estas etapas:

1. Selecione Equipes na lista suspensa de contas de usuário.
2. Clique na linha da equipe de desenvolvedores do app que você quer registrar.
3. Clique em + Novo aplicativo para criar um novo aplicativo.
4. Insira um nome e uma descrição para o aplicativo na caixa de diálogo "Novo aplicativo".

5. Selecione o proprietário do app na lista suspensa Proprietário.

   Por padrão, a equipe de desenvolvedores é a proprietária do app. Se quiser, selecione uma equipe de desenvolvedores diferente ou você mesmo como proprietário no menu suspenso.

   Observação: na versão Beta, não é possível transferir a propriedade do app depois que ele é criado.

6. Na seção "Catálogo de APIs", selecione uma ou mais APIs.

   As APIs no catálogo são categorizadas como APIs autenticadas, exigindo um URL de retorno de chamada ou APIs públicas. É preciso selecionar pelo menos uma API para criar um app.

7. Se você selecionar uma API na seção "APIs autenticadas", insira um URL de callback.

   Para mais informações, consulte Sobre URLs de callback.

8. Clique em Criar

Como gerenciar as APIs em um aplicativo

Como produtor de APIs, publique APIs para permitir que os usuários do portal consumam seus produtos de API.

Os usuários do portal gerenciam as APIs que os aplicativos usam. As APIs são adicionadas à página de detalhes do aplicativo. Para algumas APIs, a aprovação não é automática. Um status de Aprovação pendente indica uma API para a qual o acesso foi solicitado, mas ainda não concedido.

Observação: as APIs não publicadas não são exibidas no momento. Esse problema será corrigido em uma versão futura.

Se o usuário do portal desativar o acesso a uma API particular ou interna, a API será removida do aplicativo e precisará ser adicionada manualmente pelo administrador do portal, conforme descrito em Como controlar o acesso às APIs registrando aplicativos.

Os usuários do portal podem gerenciar as APIs em um aplicativo do seu portal da seguinte forma:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique no aplicativo na lista.
3. Na seção de APIs, clique em ou para ativar ou desativar o acesso, respectivamente, a uma API do aplicativo.
4. Para uma API autenticada, adicione ou edite o URL de retorno de chamada, conforme necessário.

Como ver a chave de API e o secret de um aplicativo

Os usuários do portal podem gerenciar a chave de API de um aplicativo no seu portal, da seguinte maneira:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique no aplicativo na lista.
3. Veja as chaves de API na seção "Chaves de API".
4. Confirme se o status da chave de API está Ativo.
   Se sua chave de API exigir aprovação e ainda não foi aprovada, o status será exibido como Aprovação pendente.
5. Clique em Mostrar secret para visualizar o secret.
6. Posicione o cursor sobre a chave de API ou o secret e clique em para copiá-lo na área de transferência.

Observação: se a conta de desenvolvedor ou o app tiver sido desativado/revogado, será necessário ativar/aprovar a conta de usuário ou o app novamente para que a chave de API seja válida. Para mais informações, consulte Como ativar e desativar um desenvolvedor e Como aprovar ou revogar um app.

Como fazer a rotação de uma chave de API para um aplicativo

O usuário do portal pode fazer a rotação da chave de API de um app periodicamente ou em resposta a um possível vazamento ou comprometimento. Quando um usuário do portal alterna uma chave de API, uma nova chave de API é criada com os mesmos direitos da API original. A chave de API original permanece ativa durante a transição. É necessário revogar a chave de API antiga para impedir que as credenciais dela sejam aceitas, conforme descrito em Como revogar uma chave de API para um app.

Os usuários do portal podem alternar uma chave de API de um app do seu portal da seguinte maneira:

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

Como revogar uma chave de API para um aplicativo

Quando o usuário de um portal gira uma chave de API, como descrito na seção anterior, ela permanece ativa enquanto você faz a transição. Você precisa revogar uma chave de API para evitar que as credenciais sejam aceitas.

Os usuários do portal podem revogar uma chave de API do aplicativo de seu portal da seguinte maneira:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique no nome do aplicativo.
3. Na seção "Chaves de API", clique em na coluna de ações associada à chave de API que você quer revogar.

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

   O status da chave é atualizado para revogado.

Como editar detalhes do aplicativo

Os usuários do portal podem editar os detalhes do aplicativo da seguinte maneira:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique no aplicativo na lista.
3. Edite os campos "Nome" ou "Descrição" na guia "Detalhes do aplicativo".
4. Como gerenciar as APIs em um aplicativo, conforme necessário.
5. Clique em Save.

Como excluir um aplicativo

Os usuários do portal podem excluir um aplicativo do seu portal da seguinte maneira:

1. Selecione Apps na lista suspensa da conta de usuário.
2. Clique no aplicativo na lista.
3. Clique em EXCLUIR.
4. Clique em Confirmar para confirmar a operação.

O aplicativo é excluído e removido da lista de apps.