Como registrar desenvolvedores de apps

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

Confira 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.

Aviso: a segurança das APIs, o gerenciamento de tráfego e a análise de desenvolvedores/aplicativos dependem da configuração adequada do proxy de API. Por exemplo, é necessário adicionar as políticas certas aos seus proxies, como validação de chave de API ou verificação de token de acesso OAuth, aplicação de cotas e limitação de taxa. Essas políticas identificam qual desenvolvedor e app específico está fazendo a chamada, que, por sua vez, permite a aplicação da segurança da API, o gerenciamento de tráfego específico do desenvolvedor ou do aplicativo, a captura da análise da API e outras funcionalidades. Tecnicamente, é possível desenvolver APIs abertas que não verificam chaves de API ou tokens de acesso, o que significa que não seria preciso registrar desenvolvedores. No entanto, não recomendamos essa prática porque você perderá a segurança da API, o controle sobre o desempenho, por meio de um bom gerenciamento de tráfego, os dados de análise, além de perder outros benefícios importantes que a Apigee oferece.

Como registrar desenvolvedores de apps

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

• Se você tiver uma conta paga do Apigee, os desenvolvedores poderão se registrar por meio de um portal do desenvolvedor. Para mais informações, consulte uma das seções a seguir com base no tipo de portal do desenvolvedor:
  • Portal integrado: como criar uma conta de usuário no portal integrado
  • Drupal 10: registrar um desenvolvedor de apps
• Os administradores podem registrar os desenvolvedores de apps usando a API.
• Como administrador do portal do desenvolvedor, gerencie os desenvolvedores diretamente no seu portal, conforme descrito nas seções a seguir:
  • Portal integrado: gerenciamento de usuários para gerenciar contas de usuários,
    Observação: depois que um usuário cria um aplicativo no portal integrado, conforme descrito nesta seção, as informações da conta do usuário são sincronizadas e disponibilizadas no Apigee na página de Desenvolvedores. O registro de desenvolvedor do app está associado à conta usando o endereço de e-mail do usuário. Para mais informações sobre onde são armazenadas as informações de conta e de app associadas, consulte Onde as informações da conta de desenvolvedor do app são armazenadas.
  • Drupal 10: saiba como os desenvolvedores de apps interagem com o módulo Apigee
• Como administrador da organização, é possível gerenciar os desenvolvedores que usam a IU ou a API da Apigee, conforme descrito nas seções a seguir.

Observação: Quando os usuários do portal criam uma equipe no portal integrado, as informações da equipe de desenvolvimento são armazenadas na Apigee e um endereço de e-mail exclusivo é gerado automaticamente para servir como a chave primária usada. pela Apigee para identificar a equipe de desenvolvedores. Para saber mais, consulte Onde as informações da equipe de desenvolvedores são armazenadas (Beta).

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.

Observação: para portais integrados, as contas de usuário são gerenciadas conforme descrito em Como gerenciar usuários. Depois que um desenvolvedor cria um app no portal integrado, conforme descrito em Como registrar apps, um registro de desenvolvedor separado é criado para rastrear apps associados à conta de usuário e pode ser acessado na página "Desenvolvedores". O registro do desenvolvedor está associado ao endereço de e-mail do usuário.

Para acessar a página Distribuição > Desenvolvedores:

Acessar "Desenvolvedores"

Na página Desenvolvedores, é possível:

• Adicionar um desenvolvedor.
• Visualizar e editar detalhes do desenvolvedor, incluindo os seguintes itens:
• Gerenciar atributos personalizados
• Ativar ou desativar um desenvolvedor
• Exportar dados de publicação
• Excluir um desenvolvedor
• Pesquisar a lista de desenvolvedores

Como adicionar um desenvolvedor

Para adicionar um desenvolvedor siga estas etapas:

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

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.
3. Na seção Detalhes são exibidas as seguintes informações: Clique em Editar para editar os detalhes do desenvolvedor conforme necessário.

   Detalhes	Descrição
   Detalhes	Nome, sobrenome, nome de usuário e e-mail / status do registro e duração / e o ID do desenvolvedor.
   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:

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 Editar.
4. Clique em + Adicionar atributo na seção Atributos personalizados.
5. Digite o nome e o valor do atributo.
6. Clique em Salvar.
7. Para excluir um atributo personalizado, clique em Editar, depois em Excluir e em Salvar.

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 apps, mas nenhuma das chaves de API correspondentes vai 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.

Observação:quando você desativa um desenvolvedor, pode levar alguns minutos para que a mudança seja atualizada em todos os processadores de mensagens. Até lá, algumas chamadas pelo app do desenvolvedor podem ser bem-sucedidas.

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.
3. Clique em Editar.
4. Na seção "Detalhes", defina o campo Status como Ativo ou Inativo, conforme necessário.
5. Clique em Salvar.
6. Repita as etapas se o desenvolvedor estiver em várias organizações.

Como exportar dados de publicação

Nesta seção, descrevemos como exportar dados de publicação para desenvolvedores, apps ou produtos de API como um arquivo de valores separados por vírgula (CSV) ou JSON.

Pré-requisitos:

• Bucket do Cloud Storage
• Acesso de leitura aos dados que você está exportando
• Acesso de leitura e gravação ao bucket do Cloud Storage

Para mais informações sobre intervalos, consulte:

• Sobre os buckets do Cloud Storage
• Crie um bucket
• Como listar buckets

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

1. Crie o bucket do Cloud Storage ou receba o nome de um bucket atual.
2. Acesse uma das seguintes páginas:

   • No console do Google Cloud , acesse a página Distribuição > Desenvolvedores.

     Acessar "Desenvolvedores"

   • No console do Google Cloud , acesse a página Distribuição > Apps.

     Acessar "Apps".

   • No console do Google Cloud , acesse a página Distribuição > Produtos de API.

     Acessar Produtos

3. Clique em Exportar.
4. A caixa de diálogo Salvar tabela como é exibida. Digite o nome do bucket do Cloud Storage e especifique o formato de exportação: JSON ou CSV.
5. Clique em Salvar. Uma operação de longa duração (LRO) é iniciada. O status da LRO é mostrado no ícone Notificação .
6. Quando a exportação for concluída, clique em Fazer o download na notificação. A página do bucket do Cloud Storage para o arquivo é aberta.
7. Clique em Fazer download. O arquivo é baixado para sua máquina local.

Observações sobre os dados exportados:

• A estrutura dos dados exportados segue exatamente as definições de proto. Assim, a documentação de proto pode ser usada como referência para as estruturas de dados exportadas. Consulte:
  • Desenvolvedores
  • Apps
  • Produtos de API
• Ao contrário da interface clássica da Apigee, cada recurso tem um botão de exportação independente e dedicado.
• As exportações CSV não listam campos repetidos ou aninhados do proto porque não podem ser representados corretamente em uma estrutura de dados de tabela. Para receber essas informações, é preciso usar a exportação JSON.
• Os arquivos exportados são chamados de ExportFinal_{hash}.

Como excluir um desenvolvedor

Aviso: a exclusão dos desenvolvedores remove completamente os artefatos relacionados (como apps e chaves de API) da sua organização. Para evitar a exclusão permanente de desenvolvedores e seus artefatos, desative os desenvolvedores.

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.
3. Clique em Mais e em Excluir.
4. Clique novamente em Excluir para confirmar a açã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.

Observação: se você usa o portal de desenvolvedores baseado no Drupal, o Apigee recomenda que você gerencie os desenvolvedores de apps diretamente no seu portal, não usando a Apigee. Consulte Recomendações para gerenciar contas de usuário em portais de desenvolvedor.

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

Drupal 10: sincronizar desenvolvedores com o Apigee

Como usar a API para gerenciar desenvolvedores

Gerencie desenvolvedores usando as APIs para desenvolvedores.