Como migrar desenvolvedores para a monetização

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

Se você tiver desenvolvedores que precisam migrar para a monetização, faça o seguinte:

  1. Crie produtos de API, pacotes de API e planos de tarifas para os desenvolvedores que você a migração, se eles ainda não existirem. Confira mais informações em:
  2. Publique os planos de tarifas, conforme descrito em Como publicar planos de tarifas.
  3. Adicione os novos desenvolvedores à organização, conforme descrito em Registrar desenvolvedores de apps.
  4. Recarregar o saldo pré-pago de cada desenvolvedor, conforme descrito em Gerenciar conta pré-paga de crédito.
  5. Aceite o plano de tarifação, conforme descrito em Taxa de compra planos de negócios usando a API.

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

  6. Se um desenvolvedor que você está migrando já tiver transações, é possível transferir manualmente o uso de transações com 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 etapa.

    O recurso transactions insere uma única transação que reflete a uso atual da transação e atualiza todos os contadores internos para refletir esse novo valor.

    Por exemplo, se o desenvolvedor emitiu 1.000 chamadas para a API antes da migração, para capturar a atividade atual, você pode definir o uso da transação para 1.000 chamando o transactions e definindo a propriedade batchSize como 1.000 em do 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, seus valores padrão e se mas não sã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 do uso de transações.

    O número do atributo personalizado na mensagem precisa ser especificado como um número 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 da API.

    N/A Sim
    type

    Precisa ser definido como CHARGE (que é o padrão).

    CHARGE Não

    Para pular etapas de validação e forçar a definição do número de transações, defina o o parâmetro de consulta force para true (por exemplo, ?force=true). Por padrão, o parâmetro ?force=false e as etapas de validação são executada. Por exemplo, se um desenvolvedor pré-pago não tiver saldo nem atividade na conta é suspensa. Se ?force=false, a solicitação 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 produto da API:

    $ 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 especificado e produto de API. Na solicitação, batchSize é definido como 125, e o valor do primeiro atributo personalizado definido para o produto da API é definido como 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 a configuração necessária não tiver sido cobrada de um desenvolvedor ou as taxas recorrentes, você poderá cobrar uma taxa de configuração ou recorrente por 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, será possível pular essa etapa. Chamar o recurso transactions não afetará a configuração nem recorrentes definidas pelo plano de tarifas.

    A tabela a seguir resume as propriedades de configuração que podem ser especificadas no corpo do pedido para cobrar manualmente uma taxa de configuração ou recorrente por um plano de tarifas, o padrão valores 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 dólar americano ou chf para 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 a consulta force como true (por exemplo, ?force=true). Por padrão, ?force=false e as etapas de validação foram executadas. Por exemplo, se um plano desenvolvedor tiver saldo zero e a atividade na conta for suspensa, se ?force=false, haverá falha na solicitação durante a validação.

    Por exemplo, a solicitação a seguir cobra uma taxa de configuração de US$ 10 para o desenvolvedor que se inscreveu 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