Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da
Apigee X. informações
Se você tiver desenvolvedores que precisam migrar para a monetização, faça o seguinte:
- Crie os produtos, pacotes e planos de tarifas de API para os desenvolvedores que você está migrando, se eles ainda não existirem. Para mais informações, consulte:
- Publique os planos de taxas, conforme descrito em Como publicar planos de taxas.
- Adicione os novos desenvolvedores à sua organização, conforme descrito em Registrar desenvolvedores de apps.
- Recarregue o saldo pré-pago de cada desenvolvedor, conforme descrito em Gerenciar saldos de conta pré-paga.
- Aceite o plano de taxas, conforme descrito em Comprar planos de taxas usando a API.
Observação: para isentar as taxas de configuração, se um desenvolvedor já tiver sido cobrado, defina o parâmetro de consulta
waivefees
comotrue
. - Se um desenvolvedor que você está migrando tiver transações,
você poderá transferir manualmente o uso da transação usando o seguinte recurso:
/organizations/{org_name}/transactions
, em que{org_name}
é o nome da organização.Observação:se um desenvolvedor não tiver transações, pule esta etapa.
O recurso
transactions
insere uma única transação que reflete o uso da transação atual e atualiza todos os contadores internos para refletir esse novo valor.Por exemplo, se o desenvolvedor tiver emitido 1.000 chamadas para a API antes da migração, para capturar a atividade atual, defina o uso da transação como 1.000 chamando o recurso
transactions
e definindo a propriedadebatchSize
como 1.000 no corpo da solicitação.A tabela a seguir resume as propriedades de configuração que podem ser especificadas no corpo da solicitação para definir manualmente o número de transações, os valores padrão e se elas são obrigatórias ou não.
Propriedade Descrição Padrão Obrigatório? application
ID do app do desenvolvedor.
N/A Sim batchSize
Número de transações que você quer transferir.
1 Não custAttn
Valor do atributo personalizado usado com batchSize para calcular o uso da transação.
O número do atributo personalizado na mensagem precisa ser especificado como um valor inteiro positivo ou decimal (até quatro casas decimais). Valores negativos não são permitidos.
O atributo personalizado precisa ser definido em:
- Política de gravação de transações do produto de API. Consulte Configurar uma política de gravação de transações.
- Plano de tarifas ativo para o produto da API. Consulte Configurar um plano de tarifas com atributos personalizados.
N/A Sim product
ID do produto da API.
N/A Sim type
Precisa ser definido como
CHARGE
(padrão).CHARGE
Não Para pular as etapas de validação e definir o número de transações à força, defina o parâmetro de consulta
force
comotrue
(por exemplo,?force=true
). Por padrão, as etapas?force=false
e de validação são executadas. Por exemplo, se um desenvolvedor pré-pago tiver saldo zero e a atividade na conta for suspensa, se?force=false
, a solicitação vai falhar durante a validação.Por exemplo, a solicitação a seguir define o número de transações como 50 para o aplicativo e o produto da API especificados:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize":50 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password
A solicitação a seguir define o uso da transação como 12,5 para o aplicativo e o produto de API especificados. Na solicitação,
batchSize
é definido como125
, e o valor do primeiro atributo personalizado definido para o produto da API é definido como0.1
. Quando multiplicados, 125 * 0,1 é igual a 12,5.$ curl -H "Content-Type:application/json" -X POST -d \ '{ "application":{ "id":"6a9b1afc-2110-43d6-bae7-1b137aecb05b" }, "product":{ "id":"testproduct" }, "batchSize": 125, "custAtt1" : 0.1 }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password
- Se um desenvolvedor não tiver recebido as taxas de configuração ou recorrentes necessárias, você poderá cobrar manualmente
uma taxa de configuração ou recorrente para um plano de tarifas usando o seguinte recurso:
/organizations/{org_name}/transactions
, em que{org_name}
é o nome da organização.Observação:se o desenvolvedor já tiver recebido cobranças de configuração ou recorrentes, pule esta etapa. Chamar o recurso
transactions
não afeta as taxas de configuração ou recorrentes definidas pelo plano de tarifas.A tabela a seguir resume as propriedades de configuração que podem ser especificadas no corpo da solicitação para cobrar manualmente uma taxa de configuração ou recorrente de um plano de tarifas, os valores padrão e se elas são obrigatórias ou não.
Propriedade Descrição Padrão Obrigatório? currency
Moeda usada para o plano de tarifa. Especifique o código ISO 4217 da moeda, como usd para dólar dos Estados Unidos ou chf para franco suíço.
N/A Sim developer
ID do desenvolvedor.
N/A Sim rate
Taxa de configuração ou taxa recorrente a ser cobrada.
N/A Sim ratePlan
ID do plano de taxas.
N/A Sim type
Defina como
SETUPFEES
ouRECURRINGFEES
.CHARGE
Sim Para pular as etapas de validação e cobrar a taxa à força, defina o parâmetro de consulta
force
comotrue
(por exemplo,?force=true
). Por padrão,?force=false
e as etapas de validação são executadas. Por exemplo, se um desenvolvedor pré-pago tiver saldo zero e a atividade na conta for suspensa, se?force=false
, a solicitação vai falhar durante a validação.Por exemplo, a solicitação a seguir cobra uma taxa de configuração de US$ 10 ao desenvolvedor inscrito no plano de taxas:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "developer":{ "id":"dev1@myorg.com" }, "currency":{ "id":"usd" }, "ratePlan":{ "id":"mypackage_rateplan1" }, "rate":10, "type":"SETUPFEES" }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/myOrg/transactions" \ -u email:password