Gerenciamento de empresas e desenvolvedores com o Edge

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Se você quiser ter mais controle sobre as empresas e os desenvolvedores que participam de seus programa de API, por exemplo, se você quer criar empresas internas e desenvolvedores para para fins de teste, é possível criar empresas e desenvolvedores manualmente com a UI de gerenciamento e API.

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

• Caso seus desenvolvedores de monetização precisem de credenciais de login para acessar a interface ou a API do Edge, primeiro eles precisam ter as próprias credenciais. conta de administrador da Apigee.
• Se você precisar simplesmente criar desenvolvedores de teste que não precisam de credenciais (por exemplo, se se quiser fazer chamadas de API com desenvolvedores de teste fictícios), nenhuma conta Apigee obrigatórios.

Como gerenciar desenvolvedores de apps usando a interface

Crie, gerencie e ative desenvolvedores de apps usando a interface do Edge, conforme descrito em Gerenciar desenvolvedores de apps. Depois que os desenvolvedores de apps forem criados, será possível adicioná-los às empresas, conforme descrito nas seções a seguir.

Gerenciamento de empresas usando a interface

Criar, gerenciar e ativar empresas, conforme descrito nas seções a seguir.

Como explorar a página "Empresas"

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

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 é a empresa principal administrador)
   • Tipo de faturamento

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

4. Adicionar um ou mais desenvolvedores à empresa.
   1. Na seção "Desenvolvedores", insira uma string no campo Adicionar desenvolvedor para exibir a lista de desenvolvedores que correspondem à string.
   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.

Ativação e desativação de 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 usando a API

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

Criar e atualizar empresas e desenvolvedores usando a API

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

• Criar uma empresa
• Criar um desenvolvedor
  Observação: configure as informações de monetização ao criar um desenvolvedor transmitindo atributos personalizados.
• Adicione ou atualizar desenvolvedores da empresa
  Observação: você pode atribuir um papel ao desenvolvedor, embora ele não seja obrigatório. Para conferir uma lista 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. Você pode conferir os atributos personalizados de monetização definidos usando a API padrão (sem monetização) para listar todos os desenvolvedores ou único desenvolvedor.

Como gerenciar funções de desenvolvedor usando a API

É possível criar papéis usando APIs de monetização. Isso permite que você estabeleça papéis para parceiros. Por exemplo, é possível estabelecer funções de administrador e de desenvolvedor de aplicativo para uma parceiro. Essas funções podem ser atribuídas a funcionários específicos do parceiro.

Como criar uma função de desenvolvedor

Para criar uma função de desenvolvedor, envie uma solicitação POST para organizations/{org_name}/developer-roles: Ao fazer a solicitação, você precisa especifique no corpo da solicitação o nome e a descrição da função e a identificação do 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 os papéis 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" : {
   ...
  }
}

Definições de configuração da 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 taxa de impostos de um desenvolvedor usando a API

Você pode obter a alíquota atual de um desenvolvedor emitindo 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

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 é possível realizar desenvolvedor. Por exemplo, você pode criar uma conta bancária para um desenvolvedor específico ou gerar uma o relatório de receita de um desenvolvedor específico.

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