Registrar desenvolvedores de apps

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Registre e gerencie seus desenvolvedores de aplicativos, conforme descrito nas seções a seguir. O registro de aplicativos é um processo separado, conforme descrito em Registrar aplicativos e gerenciar chaves de API.

Introdução

O Edge oferece muitos benefícios que dependem completamente 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. E como o Edge 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:

• Se você tiver uma conta paga do Edge, os desenvolvedores poderão se registrar em 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: crie uma conta de desenvolvedor no portal integrado
  • Drupal 9: registrar uma conta de desenvolvedor de apps.
  • Drupal 7: adicionar e gerenciar contas de usuário
• Os administradores podem registrar os desenvolvedores de apps usando a API.
• Como administrador do portal do desenvolvedor, gerencie os desenvolvedores diretamente no portal, conforme descrito nas seguintes seções:
  • Portal integrado: gerencie as contas de desenvolvedor para administrar as contas de desenvolvedor.
  • Drupal 9: Como os desenvolvedores de apps interagem com o módulo do Apigee Edge
  • Drupal 7: adicionar e gerenciar contas de usuário
• Como administrador da organização, gerencie desenvolvedores usando a interface ou a API do Edge, conforme descrito nas seções a seguir.

Recomendações para gerenciar contas de desenvolvedor em portais de desenvolvedor

A Apigee recomenda que você gerencie as contas de desenvolvedor diretamente no portal do desenvolvedor.

Se você usa o portal integrado, essa é a única maneira de garantir que as contas de desenvolvedor no portal integrado e no Edge fiquem sincronizadas.

Se você usa o portal do desenvolvedor com base em Drupal, o gerenciamento de contas de desenvolvedor 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 Edge, nenhum e-mail é enviado ao desenvolvedor e não é possível definir a senha dele 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 o Edge.

Se você decidir gerenciar contas de desenvolvedor baseadas em Drupal usando o Edge, vai precisar sincronizar os desenvolvedores de apps entre o portal e o Edge.

Como explorar a página do desenvolvedor

Acesse e explore a página "Desenvolvedores" usando a IU do Edge e a IU clássica do Edge.

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.

Como visualizar e editar detalhes do desenvolvedor

Visualizar e editar detalhes do desenvolvedor. Para organizações com monetização ativada, é possível editar os atributos personalizados de monetização definidos em Como configurar atributos de monetização.

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.

   Detalhes	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 os links a seguir: Gerenciar atributos personalizados para um desenvolvedor Configurar atributos de monetização
   Apps	Apps que foram registrados pelo desenvolvedor Consulte Como registrar apps.

4. Ative ou desative o desenvolvedor no campo Status.
   Para mais informações, consulte Como ativar e desativar um desenvolvedor.

Com o Apigee Edge for Public Cloud, o Edge mantém as seguintes entidades em cache por um mínimo de 180 segundos depois que elas forem acessadas.

• Tokens de acesso do OAuth Isso significa que um token revogado ainda pode ser bem-sucedido por até três minutos, até o limite de cache expirar.
• 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, incluindo aqueles descritos em Como configurar os atributos de monetização.

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 + 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 novamente em Excluir para confirmar a ação.

Sincronização de desenvolvedores de apps entre o portal e o Edge

Se você estiver usando um portal de desenvolvedor baseado em Drupal para publicar suas APIs, as mudanças feitas nos desenvolvedores de apps que usam o Edge não serão propagadas para o portal. Faça login no portal como administrador e sincronize o portal com o Edge para que as alterações apareçam no portal.

Para sincronizar seu portal do desenvolvedor com os desenvolvedores de apps definidos no Edge, consulte as seguintes seções:

• Drupal 9: sincronizar desenvolvedores com o Apigee Edge
• Drupal 7: como sincronizar desenvolvedores de apps entre o portal e o Edge

Como agrupar desenvolvedores em empresas

Com a monetização, uma empresa é um grupo de desenvolvedores gerenciados como uma única entidade. Uma empresa pode ser qualquer agrupamento apropriado para sua organização, como unidade de negócios, linha de produtos ou divisão. Agrupar desenvolvedores em empresas é útil quando você precisa ter vários desenvolvedores associados em uma única entidade corporativa. Por exemplo, talvez seja necessário configurar empresas diferentes para fins de faturamento. No entanto, os desenvolvedores da sua organização não precisam estar associados a uma empresa. Um desenvolvedor é sempre uma única entidade, identificada exclusivamente pelo elemento de e-mail. Se um desenvolvedor fizer parte de uma empresa, o nome dela vai aparecer na página "Desenvolvedores".

Para mais informações sobre como gerenciar empresas e desenvolvedores para monetização, consulte Gerenciar empresas e desenvolvedores.

Configurar atributos de monetização

Ao editar um desenvolvedor usando a interface ou criar ou editar um desenvolvedor com a API, é possível configurar as propriedades de monetização definidas na tabela a seguir. Inicialmente, você configura as propriedades de monetização da organização ao editar o perfil da organização.

Nome do campo	Nome do atributo personalizado	Descrição
Endereço	MINT_DEVELOPER_ADDRESS	Endereço do desenvolvedor, incluindo os seguintes campos: endereço (linhas 1 e 2), cidade, estado, CEP e país.
Perfil de faturamento	MINT_BILLING_PROFILE	Ciclo de faturamento da organização. Valores válidos: PRORATED: o faturamento é baseado no número de dias que um produto de API é usado em um mês. CALENDAR_MONTH: o faturamento é feito mensalmente.
Tipo de faturamento	MINT_BILLING_TYPE	Modelo de pagamento do desenvolvedor usado para faturamento. O papel pode ser um dos seguintes: PRÉ-PAGA: o desenvolvedor paga antecipadamente pelo uso de um produto de API. Os fundos são deduzidos do saldo do desenvolvedor quando o produto de API é usado. O desenvolvedor precisa manter um saldo pré-pago suficiente para comprar o produto de API. POSTPAID: o desenvolvedor é cobrado mensalmente (por meio de uma fatura) pelo uso dos produtos da API. O desenvolvedor paga pelo uso de produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura. AMBOS: aceita qualquer um dos tipos de faturamento. O padrão é PREPAID. Consulte Como configurar tipos de faturamento pré-pago e pós-pago usando a API.
Categoria	MINT_DEVELOPER_CATEGORY	Categoria do desenvolvedor à qual você quer adicionar o desenvolvedor. Uma categoria de desenvolvedor é um grupo de desenvolvedores ou empresas com características semelhantes. Para mais informações, consulte Gerenciar categorias de desenvolvedores.
ID da empresa	MINT_COMPANY_ID	ID da empresa, se aplicável Para mais informações, consulte Agrupar desenvolvedores em empresas.
Tipo de desenvolvedor	MINT_DEVELOPER_TYPE	Esta propriedade não é usada pela Apigee. Tipo de desenvolvedor. Os valores válidos incluem: TRUSTED ou UNTRUSTED
É corretor	MINT_IS_BROKER	Sinalização que especifica se a receita é baseada na rede líquida.
Nome comercial	MINT_DEVELOPER_LEGAL_NAME	A razão social do desenvolvedor que será usada em todos os relatórios. Observação: esse atributo é obrigatório se o desenvolvedor não estiver agrupado com uma empresa e quiser assinar um plano de tarifas publicado.
Autofaturamento	MINT_HAS_SELF_BILLING	Sinalização que especifica se as faturas de autofaturamento estão ativadas. Se ativado (true), a monetização vai gerar uma fatura de autofaturamento em vez de uma declaração de participação na receita. Uma fatura de autofaturamento é um documento financeiro que detalha o valor devido ao desenvolvedor. Ele funciona como uma fatura para o provedor da API em nome do desenvolvedor.
No de autorização isenta de tributos	MINT_TAX_EXEMPT_AUTH_NO	Número de isenção fiscal governamental, se aplicável.
Taxa de imposto	MINT_APPROX_TAX_RATE	Alíquota aproximada de tributos para o desenvolvedor. Especifique um valor decimal com um número máximo de três caracteres antes do decimal e quatro caracteres após o decimal.

Como usar a API para gerenciar desenvolvedores

Gerencie desenvolvedores usando as APIs para desenvolvedores.

Ao criar e atualizar um desenvolvedor por meio da API, é possível configurar os atributos de monetização descritos em Como configurar atributos de monetização, conforme necessário.