Como os desenvolvedores de apps interagem com seu portal (versão original)

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

O portal do desenvolvedor pronto para uso permite que os desenvolvedores de apps se registrem, façam login e gerenciem os apps que vão consumir suas APIs.

As seções a seguir descrevem como os desenvolvedores de apps interagem com seu portal:

Como o registro e o login do desenvolvedor do app são rastreados no Edge

O registro de desenvolvedores e o login no portal são rastreados usando o atributo personalizado _apiportal no Edge.

Quando um desenvolvedor faz o autoregistro, o atributo personalizado _apiportal é adicionado à configuração do desenvolvedor, e o status é definido como unverified para indicar que o desenvolvedor não fez login no portal. Por exemplo: {"status":"unverified","portals":{}}

Na primeira vez que o desenvolvedor faz login em um portal, o atributo personalizado _apiportal é atualizado para rastrear o nome e o horário de acesso do portal e definir o status do desenvolvedor como active. Toda vez que o desenvolvedor faz login no portal, o atributo personalizado é atualizado para redefinir o valor lastVisit (no formato de época) para esse portal. Por exemplo: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

Registrar uma conta de desenvolvedor de apps

Antes de usar suas APIs, os desenvolvedores de apps precisam se registrar criando uma conta.

Quando um desenvolvedor de apps se registra no seu portal:

• As informações do desenvolvedor do app são criadas e armazenadas no Edge. Consulte Onde as informações da conta de desenvolvedor são armazenadas.
• O desenvolvedor do app aparece na lista de desenvolvedores registrados. Consulte Conheça a página "Desenvolvedores".

Como alternativa, é possível registrar os desenvolvedores de apps em nome deles usando a interface do Edge, conforme descrito em Como registrar desenvolvedores de apps.

Os novos desenvolvedores de apps podem se registrar no seu portal da seguinte maneira:

1. Navegue até o portal.
2. Clique em Sign in.

3. Clique em Inscrever-se.
   A caixa de diálogo a seguir é exibida.

   

4. Insira as informações necessárias (nome, sobrenome e endereço de e-mail).

5. Clique em Criar.
   A caixa de diálogo a seguir é exibida.

   

6. Clique no link seguro no e-mail para abrir o portal e estabelecer a sessão autenticada.

Fazer login no portal

Depois que os desenvolvedores de apps se registrarem no seu portal, eles vão fazer login usando a página "Fazer login".

Sempre que um desenvolvedor de apps faz login em um portal, em vez de usar uma senha para autenticar o desenvolvedor, um link seguro é enviado para verificar a identidade e estabelecer uma sessão com o portal.

Os desenvolvedores de apps podem fazer login no seu portal da seguinte maneira:

1. Navegue até o portal.
2. Clique em Fazer login.
3. Insira o endereço de e-mail associado à conta.

4. Clique em Login.
   A caixa de diálogo a seguir é exibida.

   

5. Clique no link seguro no e-mail para abrir o portal e estabelecer a sessão autenticada.

Registrar aplicativos

Depois de fazer login no portal, os desenvolvedores podem registrar apps para usar os produtos de API que você publicou da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique em + App para criar um novo app.
3. Insira um nome e uma descrição para o app na caixa de diálogo "Criar app".
4. Clique em Criar.
5. Gerencie os produtos de API no app, conforme descrito abaixo.

Gerenciar os produtos de API em um app

Os desenvolvedores de apps podem gerenciar os produtos de API nos apps. Os produtos de API são adicionados à página de detalhes do aplicativo. Para alguns produtos de API, a aprovação não é automática. O status Pending indica um produto de API para o qual o acesso foi solicitado, mas ainda não foi concedido.

Os desenvolvedores de apps podem gerenciar os produtos de API em um app do seu portal da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Clique em Gerenciar produtos.

4. Clique no botão de alternância Acesso para ativar ou desativar o acesso a um produto de API no app.

   Observação: se o desenvolvedor do app desativar o acesso a um produto de API que seja privado ou interno, o produto de API será removido do app e precisará ser adicionado novamente pelo administrador do portal, conforme descrito em Registrar apps e gerenciar chaves de API.

5. Clique em Solicitar para pedir a aprovação de um produto de API que ainda não está permitido.

6. Clique em Salvar.

Conferir a chave de API de um app

Os desenvolvedores de apps podem gerenciar a chave de API de um app no seu portal da seguinte maneira:

1. Selecione Meus apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Confira a chave de API na seção Chaves.
4. Clique em Ver secret para exibir o secret da chave de API.
5. Confirme se o status da chave de API é "Aprovado".

Girar a chave de API de um aplicativo

Um desenvolvedor de apps 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 desenvolvedor de apps alterna uma chave de API, uma nova chave de API é criada com os mesmos direitos de produto de API que a chave original. A chave de API original é marcada como descontinuada, mas permanece ativa durante a transição. É necessário desativar uma chave descontinuada para impedir que as credenciais dela sejam aceitas, conforme descrito em Como desativar uma chave de API para um app.

Os desenvolvedores de apps podem alternar a chave de API principal de um app no seu portal da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Na seção "Chaves", posicione o cursor sobre a chave de API atual para exibir o menu de ações.
4. Clique em para abrir o menu de ações.
5. Clique em Girar.
6. Clique em Criar na caixa de diálogo para confirmar a operação.
7. Opcionalmente, desative a chave de API, conforme descrito abaixo.

Desativar uma chave de API para um app

Quando um desenvolvedor de apps gira uma chave de API, como descrito na seção anterior, ela é marcada como descontinuada, mas permanece ativa durante a transição. É necessário desativar uma chave descontinuada para impedir que as credenciais dela sejam aceitas.

Os desenvolvedores de apps podem desativar uma chave de API de um app no seu portal da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Na seção "Chaves", clique em Histórico de chaves para mostrar a lista de chaves descontinuadas.
4. Posicione o cursor sobre a chave de API descontinuada que você quer desativar para mostrar o menu de ações.
5. Clique em para abrir o menu de ações.
6. Clique em Desativar.
7. Clique em Desativar para confirmar a operação.
   O status da chave é atualizado para "Revogada".

Editar detalhes do app

Os desenvolvedores podem editar os detalhes do app da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Edite os campos "Nome" ou "Descrição".
4. Clique em Salvar.

O app é excluído e removido da lista "Meus apps".

Excluir um app

Os desenvolvedores de apps podem excluir um app do seu portal da seguinte maneira:

1. Selecione My Apps no menu suspenso do usuário.
2. Clique no nome do aplicativo.
3. Clique em excluir no canto superior direito da página.

O app é excluído e removido da lista "Meus apps".