Como registrar desenvolvedores de apps

Você está vendo a documentação da Apigee X.
Ver a documentação da Apigee Edge

Registre e gerencie seus desenvolvedores de aplicativos, conforme descrito nas seções a seguir. (O registro do aplicativo é um processo separado, conforme descrito em Como controlar o acesso às APIs registrando aplicativos).

Introdução

A Apigee oferece muitos benefícios que dependem inteiramente de saber quem está chamando suas APIs. Por exemplo, segurança de API, gerenciamento de tráfego e uma quantidade razoável de dados de análise dependem de saber quem está fazendo a chamada. Como a Apigee sabe quem está chamando suas APIs? Com a leitura de informações exclusivas em cada chamada de API, como um ID de usuário, uma chave de API ou um token OAuth. Essas informações exclusivas bloqueiam ou desbloqueiam a funcionalidade criada nos proxies de API, oferecendo controle total sobre o acesso e o comportamento delas.

É por isso que os desenvolvedores de aplicativos precisam se registrar para usar suas APIs. Depois de adicionados, os desenvolvedores registram os aplicativos, escolhem as APIs que querem usar e recebem as credenciais exclusivas (secrets e chaves de consumidor) necessárias para acessar suas APIs.

Como registrar desenvolvedores de apps

Registre desenvolvedores de aplicativos usando um dos seguintes métodos:

Recomendações para gerenciar contas de usuários em portais de desenvolvedor

A Apigee recomenda que você gerencie contas de usuário diretamente no seu portal.

Se você estiver usando o portal integrado, essa é a única maneira de garantir que as contas de usuário no portal integrado e na Apigee permaneçam sincronizadas.

Se você usa o portal do desenvolvedor com base em Drupal, o gerenciamento de contas de usuário diretamente no portal do desenvolvedor oferece as seguintes vantagens:

  • Ao adicionar um desenvolvedor por meio da interface do administrador no portal, é possível definir a senha do desenvolvedor para o portal e acionar uma mensagem de e-mail automática enviada ao desenvolvedor.

    Ao adicionar ou modificar um desenvolvedor usando o Apigee, nenhum e-mail é enviado ao desenvolvedor, e não é possível definir a senha para ele no portal. Portanto, o desenvolvedor precisa redefinir a senha no portal antes de fazer login.

  • Todas as alterações feitas na conta do desenvolvedor no portal são enviadas automaticamente para a Apigee.

Se você decidir gerenciar contas de usuário com base no Drupal usando o Apigee, sincronize os desenvolvedores de aplicativos entre o portal e a Apigee.

Como explorar a página do desenvolvedor

Acesse e explore a página "Desenvolvedores" usando a IU da Apigee.

Para acessar a página de Desenvolvedores:

  1. Faça login na IU da Apigee.
  2. Selecione Publicar > Desenvolvedores na barra de navegação à esquerda.

A página Desenvolvedores é exibida.

Conforme destacado na figura, a página Desenvolvedores permite que você realize as seguintes ações:

Como adicionar um desenvolvedor

Para adicionar um desenvolvedor siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique em + Desenvolvedor.
  3. Digite os detalhes do desenvolvedor, incluindo nome, sobrenome, e-mail e nome de usuário.
  4. Clique em Criar.

Consulte também Como gerenciar usuários.

Como visualizar e editar detalhes do desenvolvedor

Visualizar e editar detalhes do desenvolvedor.

Para ver e editar detalhes do desenvolvedor siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique na linha do desenvolvedor que você quer visualizar e editar para abrir os detalhes do desenvolvedor.
  3. Na seção Detalhes são exibidas as seguintes informações: Edite os detalhes do desenvolvedor conforme necessário.
    Detail Descrição
    Detalhes Nome, sobrenome, nome de usuário e e-mail / status do registro e duração / e o ID do desenvolvedor.
    Para editar os detalhes do desenvolvedor, clique em qualquer um dos seguintes campos:
    • Nome
    • Sobrenome
    • E-mail
    • Nome de usuário
    Modifique o conteúdo e pressione Enter para confirmar a alteração.
    Atributos personalizados Atributos personalizados definidos para o desenvolvedor. Configure atributos personalizados, conforme necessário. Para mais informações, consulte: Como gerenciar atributos personalizados para um desenvolvedor
    Apps Apps que foram registrados pelo desenvolvedor Consulte Como controlar o acesso às APIs registrando aplicativos.
  4. Ative ou desative o desenvolvedor no campo Status.
    Para mais informações, consulte Como ativar e desativar um desenvolvedor.

A Apigee mantém as seguintes entidades em cache por pelo menos 180 segundos após serem acessadas.

  • Tokens de acesso do OAuth Isso significa que o elemento ExpiresIn na política do OAuth v2 não poderá expirar um token de acesso em menos de 180 segundos.
  • Entidades de serviço de gerenciamento de chaves (KMS) (apps, desenvolvedores, produtos de API).
  • Atributos personalizados em tokens OAuth e entidades KMS.

Como gerenciar atributos personalizados para um desenvolvedor

Adicione até 18 atributos personalizados para cada desenvolvedor.

Para gerenciar atributos personalizados siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique na linha do desenvolvedor que você quer gerenciar atributos personalizados para abrir os detalhes.
  3. Clique em + na seção Atributos personalizados.
  4. Digite o nome e o valor do atributo.
  5. Clique em .
  6. Para excluir um atributo personalizado, posicione o cursor sobre o atributo e clique em no menu de ações.

Como ativar e desativar um desenvolvedor

Quando um desenvolvedor de app faz o registro automático no seu portal, é possível configurar se eles estão ou não ativos por padrão.

Quando um desenvolvedor está inativo, ele ainda pode fazer login no portal do desenvolvedor e criar aplicativos, mas nenhuma das chaves de API correspondentes funcionará. Os apps do desenvolvedor ainda mantêm o status de aprovação (ou outro), assim como as chaves de API, mesmo que não sejam válidas enquanto o desenvolvedor está inativo.

Para ativar ou desativar um desenvolvedor siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique na linha do desenvolvedor que você quer ativar ou desativar para abrir os detalhes do desenvolvedor.
  3. Na seção "Detalhes", defina o campo Status como Ativo ou Inativo, conforme necessário.
  4. Repita as etapas se o desenvolvedor estiver em várias organizações.

Como exportar dados de publicação

Exporte os seguintes dados de publicação como um arquivo de valores separados por vírgula (CSV):

  • Detalhes do desenvolvedor
  • Detalhes do produto dos desenvolvedores, dos aplicativos e das APIs

Para exportar dados de publicação siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique em Exportar CSV.
  3. Selecione Desenvolvedores ou Desenvolvedores, aplicativos e produtos na lista suspensa.

Os dados de publicação selecionados são baixados como um arquivo CSV.

Como excluir um desenvolvedor

Para excluir um desenvolvedor siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Posicione o cursor sobre a linha do desenvolvedor que você quer excluir para exibir o menu de ações.
  3. Clique em .
  4. Clique em Excluir para confirmar a exclusão.

Como sincronizar desenvolvedores de aplicativos entre o portal e a Apigee

Se você estiver usando um portal de desenvolvedores com base no Drupal para publicar as APIs, as alterações feitas nos desenvolvedores de apps que usam a Apigee não serão propagadas no portal. É preciso fazer login no portal como administrador e sincronizá-lo com a Apigee para que as alterações apareçam.

Para sincronizar seu portal do desenvolvedor com os desenvolvedores de apps definidos na Apigee, consulte a seguinte seção:

Drupal 8/9: sincronizar desenvolvedores com o Apigee

Como usar a API para gerenciar desenvolvedores

Gerencie desenvolvedores usando as APIs para desenvolvedores.