Como gerenciar pacotes de produtos da API

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

Agrupar um ou mais produtos de API em um único contêiner monetizado, chamado de pacote de produtos de API, conforme descrito nas seções a seguir.

O que é um pacote de produtos de API?

Um pacote de produtos de API é um conjunto de produtos de API apresentado aos desenvolvedores como um grupo e normalmente associado a um ou mais planos de preços para monetização. É possível criar vários pacotes de produtos de API e incluir um ou mais produtos de API em cada um. É possível colocar os mesmos produtos da API em pacotes diferentes e associá-los a planos de preços diferentes (ou iguais).

Os desenvolvedores só podem registrar seus aplicativos para usar um pacote de produtos de API comprando um dos planos de tarifas em vigor no momento. Um pacote de produtos de API não fica visível para os desenvolvedores até que você adicione e publique (como público) um plano de preços para o pacote de produtos (com uma data de início na data atual ou em uma data futura), conforme descrito em Como gerenciar planos de tarifas. Depois que você adicionar e publicar um plano de tarifas, os desenvolvedores que fizerem login no portal do desenvolvedor poderão selecionar o pacote de produtos da API e escolha o plano de tarifação. Como alternativa, é possível aceitar um plano de tarifas para um desenvolvedor usando a API de gerenciamento. Para mais informações, consulte Comprar planos de tarifas publicados usando a API.

Depois de adicionar um produto de API a um pacote de produtos de API, talvez seja necessário configurar faixas de preços para o produto de API. Você só precisará fazer isso se todas as condições a seguir forem verdadeiras:

• Você configura um plano de taxas de participação na receita para o produto de API.
• Os desenvolvedores cobram de terceiros pelo uso de recursos no produto de API.
• Há uma restrição mínima ou máxima no valor que os desenvolvedores podem cobrar, e você quer para notificar os desenvolvedores sobre a restrição.

Os preços mínimo e máximo são exibidos nos detalhes do pacote de produtos da API.

Como explorar a página "Pacotes de produtos"

Acesse a página "Pacotes de produtos", conforme descrito abaixo.

Como adicionar um pacote de produtos

Para adicionar um pacote de produtos da API:

1. Clique em + Pacote de produtos da API na página de pacotes de produtos.
2. Digite um nome para o pacote de produtos de API.

3. Digite o nome de um produto da API no campo Adicionar um produto.

   Conforme você digita o nome de um produto de API, uma lista de produtos de API que contêm a string é exibida em um menu suspenso. Clique no nome de um produto de API para adicioná-lo ao pacote. Repita essas etapas para adicionar outros produtos de API.

4. Repita a etapa 3 para adicionar outros nomes de produtos de API.
5. Para cada produto de API adicionado, configure a política de registro de transações.
6. Clique em Salvar pacote de produtos.

Como editar um pacote de produtos

Para editar um pacote de produtos:

1. Na página Pacotes de produtos, clique na linha do pacote que você quer editar.

   O painel do pacote de produtos é exibido.

2. Edite os campos do pacote de produtos conforme necessário.

   Consulte Configurar a política de registro de transações para mais informações.

3. Clique em Atualizar pacote de produtos.

Como gerenciar pacotes de produtos de API usando a API

As seções a seguir descrevem como gerenciar pacotes de produtos da API usando a API.

Como criar um pacote de produtos de API usando a API

Para criar um pacote de produtos de API, emita uma solicitação POST para /organizations/{org_name}/monetization-packages: Ao emitir a solicitação, você precisa:

• Identifique os produtos de API a serem incluídos no pacote de produtos de API.
• Especifique um nome e uma descrição para o pacote de produtos da API.
• Defina um indicador de status para o pacote de produtos da API. O indicador de status pode ter um dos seguintes valores: CREATED, ACTIVE, INACTIVE. Atualmente, o valor do indicador de status que você especifica é mantido no pacote de produtos da API, mas não é usado para nenhuma finalidade.

Também é possível especificar a organização.

Consulte as propriedades de configuração do pacote de produtos da API para uma lista das opções expostas a a API.

Exemplo:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

Veja a seguir um exemplo de resposta:

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

A resposta inclui informações adicionais sobre os produtos da API e quaisquer atributos especificados para esses produtos de API. Os atributos personalizados são especificados quando você cria um produto de API). Os atributos personalizados de um produto de API podem ser considerados em vários planos de preços. Para exemplo, se você configurar um plano de tabela de preços em que cobra o desenvolvedor por cada transação, É possível definir a taxa do plano com base em um atributo personalizado, como o número de bytes transmitidos em uma transação.

Como gerenciar produtos de API em um pacote de produtos de API usando a API

É possível adicionar ou excluir um produto de API de um pacote de produtos de API usando a API, conforme descrito nas nas seções a seguir.

Como adicionar um produto de API a um pacote de produtos de API

Para adicionar um produto de API a um pacote de produtos de API, emita uma solicitação POST para organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, em que {org_name} especifica o nome da organização, {package_id}. especifica o nome do pacote de produtos da API, e {product_id} especifica o ID da API. produto.

Exemplo:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

Como adicionar um produto de API a um pacote de produtos de API com API planos de preços específicos do produto

Adicionar um produto de API a um pacote de produtos de API que tenha um ou mais planos de preços específicos de produto de API definida (tabela de preços ou participação nos lucros), emita uma solicitação POST para organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, em que {org_name} especifica o nome da organização, {package_id}. especifica o nome do pacote de produtos da API, e {product_id} especifica o ID da API. produto.

É preciso transmitir os detalhes do plano de tarifação para o novo produto da API no corpo da solicitação. Exceto a matriz ratePlanRates, os valores do plano de tarifação devem corresponder àqueles especificados para todas outros produtos de API. Para mais informações sobre os atributos do plano de tarifas que podem ser definidos, consulte Propriedades de configuração para planos de tarifas.

Exemplo:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

Como excluir um produto de API de um pacote de produtos de API

Para excluir um produto de API de um pacote de produtos de API, emita uma solicitação DELETE para o organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, em que {org_name} especifica o nome da organização, {package_id}. especifica o nome do pacote de produtos da API, e {product_id} especifica o ID da API. produto.

Exemplo:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

Como visualizar pacotes de produtos de API usando a API

É possível recuperar um pacote de produtos de API específico ou todos os pacotes de produtos de API em uma organização. Você também pode recuperar pacotes de produto de API que tenham transações em determinado período, ou seja, somente pacotes para quais usuários invocam aplicativos que acessam APIs nesses pacotes com início e fim especificados data.

Visualização de um pacote de produtos de API específico: para recuperar um pacote de produtos de API, emita uma solicitação GET para /organizations/{org_name}/monetization-packages/{package_id}, onde {package_id} é a identificação do pacote de produtos da API (o ID é retornado na quando você criar o pacote de produtos da API). Exemplo:

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

Visualização de todos os pacotes de produtos da API: para recuperar todos os pacotes de produtos da API de uma organização, emita um GET para /organizations/{org_name}/monetization-packages. Exemplo:

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

É possível transmitir os seguintes parâmetros de consulta para filtrar os resultados:

A resposta para visualizar todos os pacotes de produtos de API em uma organização deve ser assim (somente parte da resposta é exibida):

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Communications",
    "displayName" : "Communications",
    "id" : "communications",
    "name" : "Communications",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

Visualização de pacotes de produtos de API com transações: para recuperar pacotes de produtos de API com transações em um em um determinado período, emita uma solicitação GET para /organizations/{org_name}/packages-with-transactions Quando você fizer a solicitação, você precisa especificar como parâmetros de consulta uma data de início e uma data de término para o período. Para exemplo, a solicitação a seguir recupera pacotes de produtos da API com transações durante o mês de Agosto de 2013.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

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

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "messaging package",
    "displayName" : "Messaging Package",
    "id" : "messaging_package",
    "name" : "Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "messaging api product",
      "displayName" : "messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  },
     ...
  } ]
}

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

Emitir um GET para conferir os pacotes de produtos de API aceitos por um desenvolvedor ou uma empresa específica para as seguintes APIs, respectivamente:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages, em que {developer_id} é o ID (endereço de e-mail) do desenvolvedor.
• /organizations/{org_name}/companies/{company_id}/monetization-packages, em que {company_id} é o ID da empresa.

Ao emitir a solicitação, você tem a opção de especificar os seguintes parâmetros de consulta:

Por exemplo, a solicitação a seguir recupera todos os pacotes de produtos de API aceitos por uma desenvolvedor:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

A seguinte solicitação recupera apenas pacotes ativos de API aceitos por uma empresa específica:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

Como excluir um pacote de produtos de API usando a API

Só é possível excluir um pacote de produtos de API se ele não tem planos de tarifas definidos.

Para excluir um pacote de produtos de API que não tenha planos de tarifas definidos, emita uma solicitação DELETE para organizations/{org_name}/monetization-packages/{package_id}, em que {org_name} especifica o nome da organização e {package_id} especifica o nome do pacote de produtos da API.

Exemplo:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \
-u email:password

Propriedades de configuração do pacote de produtos da API para a API

As seguintes opções de configuração de pacote de produtos de API são expostas à API: