Gerenciamento de empresas e desenvolvedores com o Edge

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

Se você quiser ter mais controle sobre as empresas e os desenvolvedores que participam do seu programa de APIs monetizadas, por exemplo, se quiser criar empresas e desenvolvedores internos para fins de teste, crie empresas e desenvolvedores manualmente com a API e a IU 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 interface de gerenciamento, enviar credenciais em chamadas para a API de gerenciamento do Edge ou fazer login em um portal de desenvolvedores.

• Se os desenvolvedores de monetização precisarem de credenciais de login para acessar a API ou a IU do Edge, eles precisarão ter a própria conta de administrador do Apigee.
• Se você precisar criar desenvolvedores de teste que não precisam de credenciais (por exemplo, se você quiser fazer chamadas de API com desenvolvedores de teste fictícios), não será necessário ter contas do Apigee.

Como gerenciar desenvolvedores de apps usando a interface

Crie, gerencie e ative desenvolvedores de apps usando a interface do Edge, conforme descrito em Como gerenciar desenvolvedores de apps. Depois que os desenvolvedores de apps são criados, eles podem ser adicionados a empresas, conforme descrito nas seções a seguir.

Como gerenciar empresas usando a interface

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

Como explorar a página "Empresas"

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

Como 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 definido como PREPAID ou POSTPAID. Para mais informações, consulte 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 que correspondem à string.
   2. Selecione um desenvolvedor na lista suspensa.
   3. Repita o processo para adicionar outros desenvolvedores à empresa.
5. Adicione um ou mais atributos personalizados.
   1. Na seção "Atributos personalizados", clique em + Novo.
   2. Insira o nome e o valor do atributo personalizado.
   3. Repita para adicionar outros atributos personalizados à empresa.
6. Clique em Criar empresa.

Como ativar e desativar 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 a empresa.

Como 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 mudanças.

Como 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 usando a API

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

Como criar e atualizar empresas e desenvolvedores usando a API

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

• Criar uma empresa
• Criar um desenvolvedor
  Observação: configure as informações de monetização ao criar um desenvolvedor transmitindo atributos personalizados.
• Adicionar ou atualizar desenvolvedores da empresa
  Observação: é possível atribuir uma função ao desenvolvedor, mas isso não é obrigatório. Para conferir uma lista de papéis de desenvolvedor, consulte Como recuperar papéis de desenvolvedor.
• Listar a configuração de monetização para todos os desenvolvedores ou para um único desenvolvedor
  Observação: defina as informações de monetização transmitindo atributos personalizados ao criar ou atualizar um desenvolvedor. É possível conferir os atributos personalizados de monetização definidos usando a API padrão (sem monetização) para listar todos os desenvolvedores ou um único desenvolvedor.

Como gerenciar funções de desenvolvedor usando a API

É possível criar papéis usando APIs de monetização. Isso permite 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.

Criar uma função de desenvolvedor

Para criar uma função de desenvolvedor, emita uma solicitação POST para organizations/{org_name}/developer-roles. Ao fazer a solicitação, é necessário 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 papéis de desenvolvedor

Para recuperar as funções de desenvolvedor, emita 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 de função de desenvolvedor para a API

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

Como recuperar a alíquota de um desenvolvedor usando a API

Para receber a alíquota fiscal atual de um desenvolvedor, emita uma solicitação GET para organizations/{org_name}/tax-engine. Ao fazer a solicitação, você precisa especificar 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 realizar outras tarefas específicas do desenvolvedor usando a API

Muitas das tarefas relacionadas à monetização que você pode realizar para uma organização, como criar 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 um desenvolvedor específico.

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