Registrar desenvolvedores de apps

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

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 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 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:

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

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

Se você estiver usando o portal integrado, essa é a única maneira de garantir que as contas de desenvolvedor e o Edge permaneçam sincronizados.

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 para o desenvolvedor 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 com base no Drupal usando o Edge, você deve sincronizar os desenvolvedores de aplicativos 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.

Edge

Para acessar a página "Desenvolvedores" usando a IU do Edge:

  1. Faça login em apigee.com/edge.
  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:

Edge clássico (nuvem privada)

Para acessar a página "Desenvolvedores" usando a IU clássica do Edge:

  1. Faça login em http://ms-ip:9000, em que ms-ip é o endereço IP ou o nome DNS do nó do servidor de gerenciamento.
  2. Selecione Publicar > Desenvolvedores na barra de navegação na parte de cima.

A página "Desenvolvedores" é exibida.

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 a 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.
    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:
    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 Apigee Edge para nuvem pública, o Edge mantém as seguintes entidades em cache por pelo menos 180 segundos após serem acessadas.

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

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

Como sincronizar desenvolvedores de aplicativos entre o portal e o Edge

Se você estiver usando um portal do desenvolvedor com base no Drupal para publicar as APIs, as alterações feitas nos desenvolvedores de apps que usam o Edge não serão propagadas no portal. É preciso fazer login no portal como administrador e sincronizá-lo 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 seções a seguir:

Como agrupar desenvolvedores em empresas

Com a monetização, uma empresa é um conjunto de desenvolvedores gerenciados como uma única entidade. Uma empresa pode ser qualquer agrupamento adequado à 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 a 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 ser 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 da empresa será exibido na página "Desenvolvedores".

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

Como configurar atributos de monetização

Ao editar um desenvolvedor usando a IU ou criar ou editar um desenvolvedor usando 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 dela.

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 sua organização. Valores válidos:

  • PRORATED: o faturamento é baseado no número de dias em que um produto de API é usado em um mês civil.
  • 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É-PAGO: 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 de produtos de API. O desenvolvedor paga pelo uso dos produtos de API com base nas condições de pagamento definidas pelos planos incluídos na fatura.
  • BOTH: oferece suporte a qualquer tipo 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 de desenvolvedor à qual você quer adicionar o desenvolvedor. Uma categoria de desenvolvedor é um agrupamento 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 Como agrupar desenvolvedores em empresas.
Tipo de desenvolvedor MINT_DEVELOPER_TYPE Essa propriedade não é usada pela Apigee.

Tipo de desenvolvedor. Os valores válidos incluem: TRUSTED ou UNTRUSTED
É corretor MINT_IS_BROKER Flag que especifica se a receita é baseada no valor líquido.
Nome civil MINT_DEVELOPER_LEGAL_NAME Nome civil do desenvolvedor que será usado em todos os relatórios.
Observação: esse atributo é obrigatório se o desenvolvedor não estiver agrupado com uma empresa e quiser se inscrever em um plano de tarifas publicado.
Autofaturamento MINT_HAS_SELF_BILLING Flag que especifica se as faturas de autofaturamento estão ativadas. Se ativada (true), a monetização gera uma fatura de autofaturamento em vez de um extrato 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 de API em nome do desenvolvedor.
Número de autorização de isenção fiscal MINT_TAX_EXEMPT_AUTH_NO Número de isenção fiscal do governo, se aplicável.
Taxa de imposto MINT_APPROX_TAX_RATE Taxa de imposto aproximada para o desenvolvedor. Especifique um valor decimal com um número máximo de 3 caracteres antes do decimal e 4 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 usando a API, é possível configurar os atributos de monetização descritos em Como configurar atributos de monetização, conforme necessário.