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.

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 Distribuição > Desenvolvedores:

Acessar "Desenvolvedores"

Na página Desenvolvedores, é possível:

Como adicionar um desenvolvedor

Para adicionar um desenvolvedor siga estas etapas:

  1. Acesse a página "Desenvolvedores".
  2. Clique em + Criar.
  3. Insira 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 do desenvolvedor / 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 seguida, 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 ele está ou não ativo 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.

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

Esta seção descreve como exportar dados de publicação para desenvolvedores, apps ou produtos de API como um arquivo 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 buckets, consulte:

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

  1. Crie o bucket do Cloud Storage ou saiba o nome de um bucket existente.
  2. Acesse uma das seguintes páginas:
  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, na sigla em inglês) é iniciada. O status da LRO é mostrado no ícone Notification.
  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 download do arquivo é feito na sua máquina local.
Observações sobre os dados exportados:
  • A estrutura dos dados exportados segue exatamente as definições de proto, de modo que a documentação de proto possa ser usada como referência para as estruturas de dados exportados. Consulte:
  • 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 ele não pode ser representado corretamente em uma estrutura de dados de tabela. Para conseguir essas informações, é necessário usar a exportação JSON.
  • Os arquivos exportados são nomeados como ExportFinal_{hash}.

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.
  3. Clique em Mais e, em seguida, 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.

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.