Gerenciamento de empresas e desenvolvedores com o Edge

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

Se você quiser mais controle sobre as empresas e os desenvolvedores que participam do seu programa de API monetizado (por exemplo, se quiser criar empresas e desenvolvedores internos para fins de teste), crie empresas e desenvolvedores manualmente com a API e a interface de gerenciamento.

Uma consideração principal que determina se você precisa criar empresas e desenvolvedores manualmente é se os desenvolvedores vão precisar de credenciais para fazer login na IU de gerenciamento, enviar credenciais em chamadas para a API Edge Management ou fazer login em um portal do desenvolvedor.

  • Se os desenvolvedores de monetização precisarem de credenciais de login para acessar a interface ou a API Edge, primeiro eles precisarão ter a própria conta de administrador da Apigee.
  • Se você precisar simplesmente criar desenvolvedores de teste que não precisem de credenciais (por exemplo, se quiser fazer chamadas de API com desenvolvedores de teste fictícios), nenhuma conta da Apigee é necessária.

Como gerenciar desenvolvedores de apps que usam a interface

Crie, gerencie e ative desenvolvedores de apps usando a interface do Edge, conforme descrito em Gerenciar desenvolvedores de apps. Após a criação, é possível adicionar os desenvolvedores de apps às empresas, conforme descrito nas seções a seguir.

Como gerenciar empresas que usam a interface

Crie, gerencie e ative empresas, conforme descrito nas seções a seguir.

Conheça a página "Empresas"

Acesse a página "Empresas", conforme descrito abaixo.

Edge

Para acessar a página "Empresas" usando a interface do Edge:

  1. Faça login em apigee.com/edge.
  2. Selecione Publicação > Monetização > Empresas na barra de navegação à esquerda.

A página "Empresas" é exibida.

Como destacado na figura, a página Empresas permite que você:

Borda clássica (nuvem privada)

Para acessar a página "Empresas" usando a interface 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 > Empresas na barra de navegação superior.

A página "Empresas" é exibida.

  • Consultar a lista atual de empresas
  • Gerenciar uma empresa. Mais especificamente, adicionar, ativar, editar e excluir uma empresa.
  • Ver o portal para desenvolvedores conectado (somente Drupal 7)

Adicionar uma empresa

Para adicionar uma empresa:

  1. Acesse a página "Empresas".
  2. Clique em + Empresa.
  3. Insira os detalhes da empresa.

    Os campos obrigatórios incluem:

    • Nome da empresa
    • Administrador (o usuário que é o administrador principal da empresa)
    • Tipo de faturamento

    Dependendo da configuração de faturamento da monetização, o tipo de faturamento pode ser PREPAID ou POSTPAID por padrão. Para mais informações, acesse Configurar tipos de faturamento pré-pago e pós-pago usando a API.

  4. Adicione um ou mais desenvolvedores à empresa.
    1. Na seção "Desenvolvedores", insira uma string no campo Adicionar desenvolvedor para mostrar a lista de desenvolvedores correspondentes.
    2. Selecione um desenvolvedor na lista suspensa.
    3. Repita essas etapas para adicionar outros desenvolvedores à empresa.
  5. Adicione um ou mais atributos personalizados.
    1. Na seção "Atributos personalizados", clique em + Novo.
    2. Digite o nome e o valor do atributo personalizado.
    3. Repita essas etapas para adicionar outros atributos personalizados à empresa.
  6. Clique em Criar empresa.

Ativando e desativando uma empresa

Para ativar e desativar uma empresa:

  1. Acesse a página "Empresa".
  2. Posicione o cursor sobre a empresa que você quer ativar e ative no menu de ações.
    Desative o botão para desativar a empresa.

Editar uma empresa

Para editar uma empresa:

  1. Acesse a página "Empresa".
  2. Posicione o cursor sobre a empresa que você quer editar e clique em no menu de ações.
  3. Atualize os detalhes da empresa, conforme necessário.
  4. Clique em Atualizar empresa para salvar as alterações.

Excluir uma empresa

Para excluir uma empresa:

  1. Acesse a página "Empresas".
  2. Posicione o cursor sobre a empresa que você quer excluir e clique em no menu de ações.
  3. Clique em Excluir para confirmar a operação de exclusão.

Como gerenciar empresas e desenvolvedores que usam a API

O uso da API para gerenciar empresas e desenvolvedores é descrito nas seções a seguir.

Criação e atualização de empresas e desenvolvedores usando a API

Para gerenciar empresas e desenvolvedores com a API Edge Management, consulte as seguintes seções de API:

Como gerenciar funções do desenvolvedor usando a API

É possível criar papéis usando as APIs de monetização. Assim, você pode estabelecer papéis para seus parceiros. Por exemplo, é possível estabelecer papéis de administrador e desenvolvedor de aplicativos para um parceiro. Essas funções podem ser atribuídas a funcionários específicos do parceiro.

Como criar uma função de desenvolvedor

Para criar um papel de desenvolvedor, emita uma solicitação POST para organizations/{org_name}/developer-roles. Ao fazer a solicitação, você precisa especificar no corpo da solicitação o nome e a descrição do papel e a identificação da organização. Exemplo:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "appDeveloper",
   "description": "App Developer",
   "organization": {
       "id": "{org_name}" 
   }  
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

Como recuperar funções de desenvolvedor

Para recuperar funções de desenvolvedor, envie uma solicitação GET para organizations/{org_id}/developer-roles. Exemplo:

$ curl -H "Accept:application/json" -X GET \
"https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \
-u email:password

A resposta deve ser semelhante a esta (apenas parte da resposta é exibida):

{
  "description" : "App Developer",
  "id" : "appdeveloper",
  "name" : "appDeveloper",
  "organization" : {
   ...
  }
}

Configurações da função de desenvolvedor para a API

As seguintes opções de configuração da função de desenvolvedor são expostas à API:

Nome Descrição Padrão Obrigatório?
name

É o nome da função de desenvolvedor.

N/A Sim
description

Uma descrição da função do desenvolvedor.

N/A Sim

Como recuperar a taxa de impostos de um desenvolvedor usando a API

Você pode conferir a taxa fiscal atual de um desenvolvedor emitindo uma solicitação GET para organizations/{org_name}/tax-engine. Ao fazer a solicitação, especifique a identificação do desenvolvedor como um parâmetro de consulta. Exemplo:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \
-u email:password

A resposta deverá ser parecida com esta:

0.09

Como executar outras tarefas específicas do desenvolvedor usando a API

Muitas das tarefas relacionadas à monetização que podem ser executadas para uma organização, como a criação de planos de preços ou condições de notificação, também podem ser realizadas para um desenvolvedor individual. Por exemplo, é possível criar uma conta bancária para um desenvolvedor específico ou gerar um relatório de receita para ele.

A tabela a seguir lista tarefas específicas do desenvolvedor que podem ser executadas usando APIs de monetização. A tabela também lista onde você pode encontrar instruções detalhadas sobre como executar essas tarefas.

Tarefa Onde encontrar as instruções
Visualizar os Termos e Condições aceitos por um desenvolvedor

Como visualizar os Termos e Condições aceitos por um desenvolvedor ou uma empresa usando a API

Ver pacotes de API aceitos por um desenvolvedor

Visualizar pacotes de produtos de API aceitos por um desenvolvedor ou empresa usando a API

Criar um plano de tarifas para desenvolvedores

Como gerenciar planos de tarifas

Ver planos de tarifas disponíveis para um desenvolvedor

Como explorar a página dos planos de tarifas

Ver planos de tarifas disponíveis para um desenvolvedor específico que contêm um produto específico

Como ver um plano de tarifas aceito para um desenvolvedor que contém um produto de API usando a API

Conferir apenas os planos de tarifas do desenvolvedor aceitos

Visualizar todos os planos de tarifas aceitos por um desenvolvedor usando a API

Emitir crédito para um desenvolvedor

Como emitir créditos

Definir um limite de crédito para um desenvolvedor

Como definir um limite de crédito usando a API

Conferir um limite de crédito de desenvolvedor

Como recuperar um limite de crédito usando a API

"Recarregar" (adicionar um valor) ao saldo pré-pago de um desenvolvedor

Gerenciar saldos de contas pré-pagas

Ver o saldo pré-pago de um desenvolvedor

Como conferir os saldos pré-pagos das contas de um desenvolvedor

Configurar uma condição de notificação para um desenvolvedor

Configurar notificações usando modelos

Criar e ver definições de relatórios de um desenvolvedor

Gerenciar relatórios