Etapas para configurar a monetização

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

Antes de começar

Antes de começar a usar a monetização com sua organização da Apigee, execute as seguintes tarefas de pré-requisito:

Crie uma conta do Apigee Edge, conforme descrito em Criar uma conta do Apigee Edge.
Monetização de compras. Inicialmente, o Edge não inclui a API de monetização nem integra a monetização à IU de gerenciamento. Você precisa comprar o recurso de monetização para incorporar a API de monetização e os componentes da IU de monetização ao Edge para sua organização da Apigee.

Depois de comprar a monetização, faça o seguinte:

Trabalhe com a equipe de configuração da Apigee para concluir a configuração inicial da monetização. Consulte Configuração inicial com a Apigee.
Configure a monetização. Consulte Configurar monetização.
Gere receita com suas APIs. Consulte Gerar receita com suas APIs.
gerenciar a monetização criando relatórios, gerenciando os saldos das contas etc. Consulte Gerenciar monetização.

Configuração inicial com a Apigee

Trabalhe com a equipe de configuração do Apigee Edge para concluir a configuração inicial da monetização. Com base nas informações enviadas, a equipe de configuração definirá o seguinte:

Se sua organização é uma empresa de telecomunicações,
Que tipo de faturamento você quer oferecer para desenvolvedores que compram seus planos de tarifas: pré-pago, pós-pago ou ambos. Consulte Contas pré-pagas e pós-pagas.
Se você quer dados detalhados ou resumidos extraídos da monetização para seu sistema de contabilidade e o formato de dados necessário.
Endereço de resposta de e-mail personalizado. Para notificações por e-mail sobre monetização enviadas a empresas e desenvolvedores, é configurado o endereço padrão noreply@apigee.com. É necessário solicitar um nome e endereço de resposta personalizados para sua organização.

A equipe de configuração da Apigee executa um script para sincronizar a monetização com sua organização e com todos os desenvolvedores, aplicativos e produtos de API criados com o Apigee Edge. O suporte da Apigee pode solicitar que você sincronize sua organização no futuro, conforme descrito em Sincronizar dados do Apigee Edge com monetização para mais detalhes. Não sincronize os dados de monetização, a menos que seja instruído pela Apigee.

Configurar monetização

A tabela a seguir resume as etapas necessárias para configurar a monetização para sua organização da Apigee.

Step	Descrição
Editar o perfil da sua organização	Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge define o perfil da sua organização. Você precisa editar o perfil da organização para adicionar ou atualizar informações sobre ela, conforme apropriado. Por exemplo, talvez seja necessário atualizar o tipo de faturamento, as configurações de moeda ou o modelo de tributos.
Gerenciar moedas aceitas	Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge especifica as moedas aceitas pela sua organização e define a moeda padrão. É possível recuperar as moedas aceitas pela sua organização e adicionar ou excluir moedas aceitas (para refletir as moedas usadas por um desenvolvedor ou plano de tarifas). Observação: a monetização executa automaticamente um job diário que obtém a taxa de câmbio em dólares americanos para cada moeda aceita. Por padrão, o job é executado todos os dias à 1 segundo depois da meia-noite. Para mais detalhes, consulte Programar jobs de monetização.
Especificar os Termos e Condições	Como opção, é possível adicionar Termos e Condições ao perfil da sua organização antes de publicar os planos de tarifa. Depois disso, a versão atual dos Termos e Condições será exibida no portal do desenvolvedor. Observação: os Termos e Condições não estão no perfil da sua organização. No perfil da sua organização, você especifica o local (URL público) dos termos e condições. É possível adicionar várias versões dos Termos e Condições para refletir as mudanças ao longo do tempo.
Definir limites de monetização	Anexe a política MonetizeLimitsCheck aos proxies de API para aplicar os limites de monetização. Especificamente, a política é acionada nas seguintes condições: O desenvolvedor que acessa a API monetizada não está registrado ou não se inscreveu no plano de tarifas. O desenvolvedor excedeu o volume de transações do plano de assinatura. O saldo da conta pré-paga ou o limite de crédito pós-pago do desenvolvedor foi atingido.
Configurar notificações	Configure notificações para avisar os desenvolvedores ou provedores de API sobre um evento específico, como um plano de tarifas recém-publicado.

Gere receita com suas APIs

Ao gerar receita com APIs, você agrupa um ou mais produtos de API em um pacote e define o plano de tarifas associado.

Um pacote de produtos da API não fica visível para os desenvolvedores até que você publique um plano de tarifa para ele (com uma data de início na data atual ou uma data futura). Os desenvolvedores só podem registrar os apps para usar um pacote de produtos da API comprando um dos planos de tarifas em vigor. Se um pacote de produtos da API não tiver um plano de tarifas publicado que esteja em vigor no momento, o pacote não vai gerar receita.

A tabela a seguir resume as etapas necessárias para gerar receita com suas APIs.

Step	Descrição
Gerenciar pacotes de produtos da API	Crie pacotes de produtos de API para agrupar seus produtos de API. Observação: na interface clássica do Edge e na API de monetização, os pacotes de produtos são chamados de pacotes de API. Se quiser usar a API para gerenciar pacotes de produtos, consulte os seguintes artigos: Como criar um pacote de produtos de API usando a API Como gerenciar os produtos de API em um pacote de produtos usando a API Como visualizar pacotes de produtos usando a API Visualização de pacotes de produtos da API aceitos por um desenvolvedor usando a API Como excluir um pacote de produtos da API
Configurar a política de gravação de transações	Configure a política de registro de transações para cada um dos produtos de API. A política de registro de transações define o que você quer capturar nos registros da transação de um produto de API, incluindo os atributos personalizados. Se quiser usar a API para configurar a política de gravação de transações, consulte: Como criar uma política de gravação de transações usando a API Como especificar critérios de sucesso da transação usando a API Como especificar atributos personalizados usando a API
Gerenciar e publicar planos de tarifas	Crie um plano de tarifas para definir a abordagem de monetização para suas APIs. Por exemplo, se você cobra uma taxa fixa ou variável pelo uso da sua API. Para gerenciar planos de tarifas usando a API, consulte: Como visualizar planos de tarifas usando a API Como criar planos de tarifas usando a API Como editar o rascunho de um plano de tarifas usando a API Como excluir um rascunho de plano de tarifas usando a API
Comprar um plano de tarifas publicado	Comprar um plano de tarifa publicado e usar a API para expirar ou cancelar um plano comprado, se quiser.
Configurar a monetização no portal do desenvolvedor	Configure a monetização no portal do desenvolvedor para oferecer aos desenvolvedores acesso de autoatendimento à assinatura do plano de tarifas, ao processamento e ao faturamento de pagamentos automáticos, aos relatórios, aos catálogos de produtos e a outras configurações específicas de monetização.

Gerenciar monetização

Depois de configurar a monetização e gerar receita com a API, você pode realizar uma ou mais etapas resumidas na tabela a seguir:

Step	Descrição
Gerenciar empresas e desenvolvedores	Gerenciou as empresas e os desenvolvedores que usam suas APIs. Um desenvolvedor é uma entidade única, identificada exclusivamente pelo endereço de e-mail. Uma empresa é um conjunto de desenvolvedores gerenciados como uma única entidade.
Criar relatórios	Crie relatórios pré-pagos de saldo, receita e variação. Para desenvolvedores pré-pagos, é possível reconciliar relatórios de saldo pré-pago com depósitos bancários.
Fazer ajustes de serviço	Faça ajustes de serviço para corrigir discrepâncias nos seus registros, por exemplo.
Créditos de emissão	Emitir créditos de desenvolvedor, se necessário. Para um desenvolvedor pré-pago, um crédito aparece como uma redução no uso que aumenta o saldo pré-pago dele daqui para frente. Para um desenvolvedor pós-pago, um crédito aparece como uma linha separada em uma fatura, reduzindo a cobrança.
Gerenciar saldos de contas pré-pagas	Confira o saldo atual da conta pré-paga e recarregue as contas pré-pagas ou configure a recarga automática usando um provedor de pagamento terceirizado.
Gerenciar saldos pós-pagos usando limites de crédito	Ao adicionar uma moeda compatível com uma organização, é possível definir um limite de crédito para um desenvolvedor pós-pago. O limite de crédito se aplica a todos os desenvolvedores pós-pagos da organização. Além disso, é possível definir o limite de crédito de um desenvolvedor pós-pago individual. Nesse caso, o limite de crédito substitui qualquer limite definido para a moeda somente para o desenvolvedor especificado.
Pós-reembolsos	Postar reembolsos para desenvolvedores para transações de compra.
Programar jobs de monetização	A monetização fornece um programador de jobs e um conjunto de tarefas pré-agendadas para serem executadas em horários designados. Gerencie a programação do job de monetização usando a API.
Conferir o status das transações	Veja o status das transações que ocorreram durante um período especificado usando a API.
Sincronizar dados do Apigee Edge com monetização	Se a Apigee receber uma instrução para fazer isso, sincronize os dados novamente com a monetização para garantir que eles estejam sincronizados. É possível sincronizar os seguintes itens: organização, produtos de API, desenvolvedores e aplicativos.
Excluir dados de monetização da sua organização	É possível excluir os dados de monetização da sua organização para limpar a organização de teste ou excluir uma organização.