Como migrar desenvolvedores para a monetização

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Caso você tenha desenvolvedores que precise migrar para a monetização, faça o seguinte:

  1. Crie os produtos de API, os pacotes de API e os planos de tarifas para os desenvolvedores que você está migrando, se eles ainda não existirem. Para mais informações, consulte os links a seguir:
  2. Publique os planos de tarifas, conforme descrito em Como publicar planos de tarifas.
  3. Adicione os novos desenvolvedores à sua organização, conforme descrito em Registrar desenvolvedores de apps.
  4. Recarregue o saldo pré-pago de cada desenvolvedor, conforme descrito em Gerenciar saldos pré-pagos de contas.
  5. Aceite o plano de tarifas, conforme descrito em Comprar planos de tarifa usando a API.

    Observação: para dispensar as taxas de configuração, se um desenvolvedor já tiver sido cobrado, defina o parâmetro de consulta waivefees como true.

  6. Se um desenvolvedor que está migrando tiver transações atuais, será possível 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 atuais, 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 propriedade batchSize 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 delas e se são ou não obrigatórios.

    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 positivo inteiro ou decimal com até quatro casas decimais. Valores negativos não são permitidos.

    O atributo personalizado precisa ser definido em:

    N/A Sim
    product

    ID do produto da API.

    N/A Sim
    type

    Precisa ser definido como CHARGE, que é o padrão.

    CHARGE Não

    Para pular as etapas de validação e forçar a definição do número de transações, defina o parâmetro de consulta force como true (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 define o número de transações como 50 para o aplicativo e o produto de 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 como 125, e o valor do primeiro atributo personalizado definido para o produto da API é 0.1. Quando multiplicados juntos, 125 * 0,1 é 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
    
  7. Se o desenvolvedor não tiver recebido a cobrança da configuração ou das taxas recorrentes necessárias, será possível cobrar manualmente uma taxa recorrente de configuração ou de 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 taxas recorrentes, pule esta etapa. Chamar o recurso transactions não afetará a configuração ou as taxas 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 configuração ou taxa recorrente de um plano de tarifas, os valores padrão deles e se eles são ou não obrigatórios.

    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 o dólar americano ou chf para o franco suíço.

    N/A Sim
    developer

    ID do desenvolvedor.

    N/A Sim
    rate

    Configuração ou taxa recorrente a ser cobrada.

    N/A Sim
    ratePlan

    ID do plano de taxas.

    N/A Sim
    type

    Defina como SETUPFEES ou RECURRINGFEES.

    CHARGE Sim

    Para pular as etapas de validação e forçar a cobrança da taxa, defina o parâmetro de consulta force como true (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 10 em dólares americanos do desenvolvedor inscrito no plano de tarifas:

    $ 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