Esta é a documentação do Apigee Edge.
Acesse
Documentação da Apigee X. informações
Uma categoria de desenvolvedor é um agrupamento de desenvolvedores ou empresas com características semelhantes que permitem configurar a monetização para operar nessa categoria específica. Por exemplo, pode criar planos de preços que se aplicam a todos os desenvolvedores que desenvolvem aplicativos para participação na receita, criar uma categoria de desenvolvedor chamada "revenue_sharing" e adicionar desenvolvedores a ele. Para mais Para mais informações sobre a criação de planos de preços com categorias de desenvolvedor, consulte Criar planos de preços.
Como explorar a página "Categorias de desenvolvedores"
Acesse a página "Categorias de desenvolvedores" usando a interface do Edge ou a interface clássica do Edge, conforme descrito nas seções a seguir.
interface do Edge
Para acessar a página "Desenvolver categorias":
- Faça login em apigee.com/edge.
- Selecione Publicar > Monetização > Categorias de desenvolvedor na barra de navegação à esquerda.
A página "Categorias do desenvolvedor" será exibida.
Como destacado na figura, a página "Categorias do desenvolvedor" permite que você:
Edge clássico (nuvem privada)
Para acessar a página "Develop Categories" usando a interface clássica do Edge:
- 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. - Selecione Publicar > Categorias de desenvolvedor na barra de navegação superior.
A página "Categorias do desenvolvedor" será exibida.
A página "Categorias do desenvolvedor" permite que você:
Adicionar uma categoria de desenvolvedor
Para adicionar uma categoria de desenvolvedor usando a interface:
- Acesse a página Desenvolver categorias.
- Clique em + Categoria do desenvolvedor.
- Insira um nome para a nova categoria e uma breve descrição.
- Clique em Criar categoria de desenvolvedor.
Adicionar uma empresa a uma categoria de desenvolvedor
Adicione uma empresa a uma categoria de desenvolvedor. Uma empresa só pode pertencer a uma categoria de desenvolvedor.
Para adicionar uma empresa a uma categoria de desenvolvedor:
- Selecione Publicar > Empresas na barra de navegação superior.
- Selecione a empresa que você quer adicionar à categoria de desenvolvedor.
- Clique em Editar na página da empresa.
- Selecione a Categoria do desenvolvedor para a empresa.
- Clique em Salvar.
Editar uma categoria de desenvolvedor
Para editar uma categoria de desenvolvedor usando a interface:
- Acesse a página Desenvolver categorias.
- Posicione o cursor sobre a categoria de desenvolvedor que você quer editar e clique em
.
- Insira a categoria do desenvolvedor.
- Clique em Atualizar categoria do desenvolvedor.
Excluir uma categoria de desenvolvedor
Para excluir uma categoria de desenvolvedor usando a interface:
- Acesse a página Desenvolver categorias.
- Posicione o cursor sobre a categoria de desenvolvedor que você quer editar.
- Clique em
.
- Clique em Excluir para confirmar a operação.
Como gerenciar categorias de desenvolvedores usando a API
Gerencie as categorias de desenvolvedores usando a API, conforme descrito nas seções a seguir.
Como adicionar uma categoria de desenvolvedor usando a API
Adicione uma categoria de desenvolvedor emitindo uma solicitação POST para
/mint/organizations/{org_name}/developer-categories
:
Ao emitir a solicitação, você especifica a categoria name
e
description
no payload. Exemplo:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Content-Type:application/json" \ -d '{ "name": "Gold", "description": "Gold membership" }' \ -u email:password
A resposta deverá ser parecida com esta:
{ "description" : "Gold membership", "id" : "aa6f960a-d9fd-416e-be39-c071418aabd0", "name" : "Gold" }
Adicionar um desenvolvedor ou uma empresa a uma categoria de desenvolvedor usando a API
Adicione um desenvolvedor ou uma empresa a uma categoria de desenvolvedor ao adicionar ou editar a empresa ou desenvolvedor emitindo uma POST para os seguintes recursos, respectivamente:
- /organizations/{org_name}/companies
- /organizations/{org_name}/developers
Para adicionar um desenvolvedor ou uma empresa a uma categoria ao editar a empresa ou o desenvolvedor, emita uma PUT para os seguintes recursos, respectivamente:
- /organizations/{org_name}/companies/{company_id}
- /organizations/{org_name}/developers/{developer_id}
Uma empresa ou um desenvolvedor só pode pertencer a uma categoria de desenvolvedor.
Especifique o MINT_DEVELOPER_CATEGORY
como um atributo no corpo da solicitação com o
o ID interno da categoria como o valor. Por exemplo, a solicitação a seguir adiciona um objeto
para a categoria de desenvolvedor chamada "Ouro" categoria, que tem um ID de
aa6f960a-d9fd-416e-be39-c071418aabd0
:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/K4jW2QLjZ1h8GFA8" \ -H "Content-Type: application/json" \ -d '{ "email" : "developer@apigee.com", "developerId" : "K4jW2QLjZ1h8GFA8", "firstName" : "Dev", "lastName" : "One", "userName" : "devone", "attributes" : [ { "name" : "MINT_REGISTRATION_ID", "value" : "dev1" }, { "name" : "MINT_DEVELOPER_LEGAL_NAME", "value" : "DEV ONE" }, { "name" : "MINT_DEVELOPER_TYPE", "value" : "TRUSTED" }, { "name" : "MINT_BILLING_TYPE", "value" : "PREPAID" }, { "name" : "MINT_IS_BROKER", "value" : "TRUE" }, { "name" : "MINT_DEVELOPER_CATEGORY", "value" : "aa6f960a-d9fd-416e-be39-c071418aabd0" }, { "name" : "MINT_DEVELOPER_ADDRESS", "value" : "{ "address1": "Dev One Address", "city": "Pleasanton", "country": "US", "isPrimary": "true", "state": "CA", "zip": "94588" }" } }' \ -u email:password
Visualizar categorias de desenvolvedores usando a API
conferir uma categoria específica ou todas as categorias de desenvolvedores em uma organização;
Visualizar uma categoria de desenvolvedor específica emitindo uma solicitação GET para
/mint/organizations/{org_name}/developer-categories/{category_id}
, em que
{category_id}
é a identificação da categoria do desenvolvedor (o ID é retornado
a resposta quando você adiciona a categoria de desenvolvedor). Exemplo:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
Ver todas as categorias de desenvolvedores de API de uma organização emitindo uma solicitação GET para
/mint/organizations/{org_id}/developer-categories
: Exemplo:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories" \ -H "Accept:application/json" \ -u email:password
Editar uma categoria de desenvolvedor usando a API
Editar uma categoria de desenvolvedor emitindo uma solicitação PUT para
/mint/organizations/{org_name}/developer-categories/{category_id}
, em que
{category_id}
é a identificação da categoria a ser atualizada. É necessário especificar no corpo da solicitação as configurações atualizadas e o ID do desenvolvedor
categoria. Por exemplo, a solicitação a seguir edita a descrição de uma categoria de desenvolvedor:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Content-Type: application/json" \ -d '{ "id": "aa6f960a-d9fd-416e-be39-c071418aabd0", "description": "Premium membership" }' \ -u email:password
Excluir uma categoria de desenvolvedor usando a API
Excluir uma categoria de desenvolvedor emitindo uma solicitação DELETE para
/mint/organizations/{org_name}/developer-categories/{category_id}
, em que
{category_id}
é a identificação da categoria de desenvolvedor que será excluída. Por
exemplo:
curl -X DELETE "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/developer-categories/aa6f960a-d9fd-416e-be39-c071418aabd0" \ -H "Accept:application/json" \ -u email:password
Propriedades de configuração da categoria de desenvolvedor para a API
A tabela a seguir resume as propriedades de configuração que podem ser definidas usando a API.
Nome | Descrição | Padrão | Obrigatório? |
---|---|---|---|
name |
nomes de propriedades. Definido como MINT_DE entregaR_CATEGORY. |
N/A | Sim |
value |
É o ID da categoria de desenvolvedor a que ele foi adicionado. |
N/A | Sim, para definir a categoria do desenvolvedor. |