Gerenciar categorias de desenvolvedores

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

Uma categoria de desenvolvedor é um agrupamento de desenvolvedores ou empresas com características semelhantes que permite você configurar a monetização para operar nessa categoria específica. Por exemplo, você pode criar planos de taxas que se aplicam a todos os desenvolvedores que criam apps para compartilhamento de receita criando uma categoria de desenvolvedor chamada "revenue_sharing" e adicionando desenvolvedores a ela. Para mais informações sobre como criar planos de taxas com categorias de desenvolvedores, consulte Criar planos de taxas.

Como acessar 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.

Como adicionar uma categoria de desenvolvedor

Para adicionar uma categoria de desenvolvedor usando a interface:

1. Acesse a página "Categorias de desenvolvedores".
2. Clique em + Categoria de desenvolvedor.
3. Insira um nome para a nova categoria e uma breve descrição.
4. Clique em Criar categoria de desenvolvedor.

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

1. Selecione Publicar > Empresas na barra de navegação na parte de cima.
2. Selecione a empresa que você quer adicionar à categoria de desenvolvedor.
3. Clique em Editar na página da empresa.
4. Selecione a categoria de desenvolvedor da empresa.
5. Clique em Salvar.
   

Como editar uma categoria de desenvolvedor

Para editar uma categoria de desenvolvedor usando a interface:

1. Acesse a página "Categorias de desenvolvedores".
2. Posicione o cursor sobre a categoria de desenvolvedor que você quer editar e clique em .
3. Insira a categoria de desenvolvedor.
4. Clique em Atualizar categoria de desenvolvedor.

Como excluir uma categoria de desenvolvedor

Para excluir uma categoria de desenvolvedor usando a interface:

1. Acesse a página "Categorias de desenvolvedores".
2. Posicione o cursor sobre a categoria de desenvolvedor que você quer editar.
3. Clique em .
4. Clique em Excluir para confirmar a operação.

Como gerenciar categorias de desenvolvedores usando a API

Gerencie 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, especifique o name e description da categoria 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"
}

Como 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 o desenvolvedor emitindo uma POST solicitação para os seguintes recursos, respectivamente:

• /organizations/{org_name}/companies
• /organizations/{org_name}/developers

Para adicionar um desenvolvedor ou uma empresa a uma categoria de desenvolvedor ao editar a empresa ou o desenvolvedor, emita uma solicitação 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 ID interno da categoria como valor. Por exemplo, a solicitação a seguir adiciona um desenvolvedor já existente à categoria de desenvolvedor chamada "Gold", 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

Como visualizar categorias de desenvolvedores usando a API

Visualize uma categoria de desenvolvedor específica ou todas as categorias de desenvolvedores em uma organização.

Para visualizar uma categoria de desenvolvedor específica, emita uma solicitação GET para /mint/organizations/{org_name}/developer-categories/{category_id}, em que {category_id} é a identificação da categoria de desenvolvedor (o ID é retornado em 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

Para visualizar todas as categorias de desenvolvedores de API de uma organização, emita 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

Como editar uma categoria de desenvolvedor usando a API

Edite 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 da categoria de desenvolvedor. 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

Como excluir uma categoria de desenvolvedor usando a API

Exclua uma categoria de desenvolvedor emitindo uma solicitação DELETE para /mint/organizations/{org_name}/developer-categories/{category_id}, onde {category_id} é a identificação da categoria de desenvolvedor a ser excluída. 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 de categoria de desenvolvedor para a API

A tabela a seguir resume as propriedades de configuração que podem ser definidas usando a API.