Como migrar desenvolvedores para a monetização

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

Se você tiver desenvolvedores que precisam ser migrados para a monetização:

  1. Crie os produtos de API, pacotes de API e planos de taxas para os desenvolvedores que você está migrando, se eles ainda não existirem. Para mais informações, consulte:
  2. Publique os planos de taxas, conforme descrito em Como publicar planos de taxas.
  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 de contas pré-pagas.
  5. Aceite o plano de taxas, conforme descrito em Comprar planos de taxas usando a API.

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

  6. Se um desenvolvedor que você está migrando tiver transações atuais, 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 atuais, pule esta etapa.

    O recurso transactions insere uma única transação que reflete o uso atual da transação 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 transactions recurso e definindo a batchSize propriedade 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 de 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:

    N/A Sim
    product

    ID do produto de 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 definir o número de transações à força, 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 um 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 para o primeiro atributo personalizado definido para o produto de API é definido como 0.1. Quando multiplicados, 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 um desenvolvedor não tiver sido cobrado as taxas de configuração ou recorrentes necessárias, você poderá cobrar manualmente uma taxa de configuração ou recorrente para um plano de taxas usando o seguinte recurso:
    /organizations/{org_name}/transactions, em que {org_name} é o nome da organização.

    Observação: se o desenvolvedor já tiver sido cobrado taxas de configuração ou recorrentes, você pode pular esta etapa. Chamar o recurso transactions não afeta as taxas de configuração ou recorrentes definidas pelo plano de taxas.

    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 para um plano de taxas, 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 taxas. Especifique o código ISO 4217 da moeda, como usd para dólar norte-americano ou chf para franco suíço.

    N/A Sim
    developer

    ID do desenvolvedor.

    N/A Sim
    rate

    Taxa de configuração ou 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 cobrar a taxa à força, 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 um 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 dólares norte-americanos do 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