Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
O portal do desenvolvedor pronto para uso permite que os desenvolvedores registrem, façam login e gerenciem os aplicativos que consomem 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 de apps são rastreados no Edge
O registro do desenvolvedor e o login no portal são rastreados com o atributo personalizado _apiportal no Edge.
Quando um desenvolvedor se registra, o atributo personalizado _apiportal é adicionado à configuração, e o status do desenvolvedor é definido como unverified para indicar que ele 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 acompanhar o nome e o horário de acesso do portal, além de definir o status do desenvolvedor como active. Sempre que o desenvolvedor faz login no portal, o atributo personalizado é atualizado para redefinir o valor de lastVisit (no formato de época) desse portal. Por exemplo: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}
Registrar uma conta de desenvolvedor de apps
Antes que os desenvolvedores de apps possam usar suas APIs, eles precisam se registrar criando uma conta.
Quando um desenvolvedor de apps se registra no seu portal:
- As informações do desenvolvedor de apps são criadas e armazenadas no Edge. Consulte Onde as informações da conta de desenvolvedor são armazenadas.
- O desenvolvedor de apps aparece na lista de desenvolvedores registrados. Consulte Explorar a página "Desenvolvedores".
Outra opção é registrar desenvolvedores de apps em nome deles usando a interface do Edge, conforme descrito em Registrar desenvolvedores de apps.
Novos desenvolvedores de apps podem se registrar no seu portal da seguinte maneira:
- Navegue até o portal.
- Clique em Fazer login.
Clique em Inscrever-se.
A caixa de diálogo a seguir vai aparecer.
Insira as informações necessárias (nome, sobrenome e endereço de e-mail).
Clique em Criar.
A caixa de diálogo a seguir vai aparecer.
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 na página correspondente.
Sempre que um desenvolvedor de apps faz login em um portal, em vez de usar um segredo compartilhado, como 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 portal da seguinte maneira:
- Navegue até o portal.
- Clique em Sign In.
- Insira o endereço de e-mail associado à conta.
Clique em Login.
A caixa de diálogo a seguir vai aparecer.
Clique no link seguro no e-mail para abrir o portal e estabelecer a sessão autenticada.
Registrar aplicativos
Após fazer login no portal, os desenvolvedores de aplicativos podem registrar aplicativos para usar os produtos de API que você publicou da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique em + App para criar um novo app.
- Insira um nome e uma descrição para o aplicativo na caixa de diálogo "Create App".
- Clique em Criar.
- 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 próprios 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 aplicativos podem gerenciar os produtos de API em um aplicativo pelo seu portal da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Clique em Gerenciar produtos.
Clique no botão Acesso para ativar ou desativar o acesso a um produto de API pelo app.
Observação: se o desenvolvedor do app desativar o acesso a um produto de API particular ou somente interno, o produto de API será removido do app e precisará ser adicionado novamente manualmente pelo administrador do portal, conforme descrito em Registrar apps e gerenciar chaves de API.
Clique em Solicitar para solicitar a aprovação de um produto de API que ainda não é permitido.
Clique em Salvar.
Ver a chave de API de um app
Os desenvolvedores podem gerenciar a chave de API de um app no seu portal da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Veja a chave de API na seção Chaves.
- Clique em Ver secret para mostrar a chave secreta da chave de API.
- Confirme se o status da chave de API é "Aprovado".
Girar a chave de API de um aplicativo
Um desenvolvedor de aplicativos pode alternar a chave de API de um aplicativo periodicamente ou em resposta a um possível vazamento ou comprometimento. Quando um desenvolvedor de apps faz a rotação de uma chave de API, uma nova chave é criada com os mesmos direitos de produto de API que a chave original. A chave de API original foi marcada como descontinuada, mas permanece ativa durante a transição. Desative 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:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Na seção "Chaves", posicione o cursor sobre a chave de API atual para exibir o menu de ações.
- Clique em
para abrir o menu de ações. - Clique em Alternar.
- Clique em Criar na caixa de diálogo para confirmar a operação.
- Como opção, desative a chave de API, conforme descrito abaixo.
Desativar a chave de API de um app
Quando um desenvolvedor de apps faz a rotação de uma chave de API, conforme descrito na seção anterior, a chave de API é marcada como descontinuada, mas permanece ativa durante a transição. Desative uma chave descontinuada para impedir que as credenciais dela sejam aceitas.
Os desenvolvedores podem desativar uma chave de API para um app no seu portal da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Na seção "Chaves", clique em Histórico de chaves para exibir a lista de chaves obsoletas.
- Posicione o cursor sobre a chave de API descontinuada que você quer desativar para mostrar o menu de ações.
- Clique em para abrir o menu de ações.
- Clique em Desativar.
- Clique em Desativar para confirmar a operação.
O status da chave é atualizado para "Revogado".
Editar detalhes do app
Os desenvolvedores podem editar os detalhes do app da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Edite os campos "Nome" ou "Descrição".
- Clique em Salvar.
O app será excluído e removido da lista "Meus apps".
Excluir um app
Os desenvolvedores podem excluir um app do portal da seguinte maneira:
- Selecione My Apps na lista suspensa do usuário.
- Clique no nome do app.
- Clique em excluir no canto superior direito da página.
O app será excluído e removido da lista "Meus apps".