Etapas para configurar a monetização

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

Antes de começar

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

• Crie uma conta do Apigee Edge, conforme descrito em Criar uma conta do Apigee Edge.
• Compre a monetização. O Edge não inclui inicialmente a API Monetization nem integra a monetização à interface de gerenciamento. É necessário comprar o recurso de monetização para incorporar a API Monetization e os componentes da interface de monetização ao Edge da sua organização da Apigee.

Depois de comprar a monetização, é necessário realizar as seguintes tarefas:

• 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 a monetização.
• Monetize suas APIs. Consulte Monetizar suas APIs.
• Gerencie a monetização criando relatórios, gerenciando saldos de contas e assim por diante. Consulte Gerenciar a 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 suas informações, a equipe de configuração vai definir o seguinte:

• Se sua organização é uma empresa de telecomunicações.
• Qual tipo de faturamento você quer oferecer aos desenvolvedores que compram seus planos de taxas: 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 no seu sistema de contabilidade e o formato de dados necessário.
• Endereço de resposta de e-mail personalizado. Para notificações de e-mail de monetização enviadas a empresas e desenvolvedores, um endereço noreply@apigee.com padrão é configurado. É 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 todos os desenvolvedores, aplicativos e produtos de API que você criou usando 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 a monetização para mais detalhes. Não sincronize dados de monetização, a menos que seja instruído pela Apigee.

Configurar a monetização

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

Etapa	Descrição
Editar o perfil da organização	Como parte da configuração inicial da monetização, a equipe de configuração do Apigee Edge configura o perfil da sua organização. É necessário 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 imposto.
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 um plano de taxas). Observação: a monetização executa automaticamente um job diário que recebe a taxa de câmbio em dólares americanos para cada moeda aceita. Por padrão, o job é executado todos os dias às 00h00 e 1 segundo. Para mais detalhes, consulte Programar jobs de monetização.
Especificar Termos e Condições	Opcionalmente, é possível adicionar Termos e Condições ao perfil da sua organização antes de publicar planos de taxas. Depois de publicar um plano de taxas, a versão atual dos Termos e Condições será exibida no portal do desenvolvedor. Observação: os Termos e Condições ficam fora do perfil da sua organização. No perfil da sua organização, especifique 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.
Aplicar limites de monetização	Anexe a política MonetizationLimitsCheck 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 assinou o plano de taxas. O desenvolvedor excedeu o volume de transações do plano de taxas assinado. O saldo da conta pré-paga ou o limite de crédito pós-pago do desenvolvedor foi atingido.
Como configurar notificações	Configure notificações para informar desenvolvedores ou provedores de API sobre um evento específico, como um plano de taxas recém-publicado.

Monetizar suas APIs

Ao monetizar APIs, você agrupa um ou mais produtos de API em um pacote de produtos de API e define o plano de taxas associado.

Um pacote de produtos de API só fica visível para os desenvolvedores quando você publica um plano de taxas para o pacote (com uma data de início da data atual ou uma data futura). Os desenvolvedores só podem registrar os apps para usar um pacote de produtos de API comprando um dos planos de taxas em vigor. Se um pacote de produtos de API não tiver um plano de taxas publicado que esteja em vigor, o pacote não será monetizado.

A tabela a seguir resume as etapas necessárias para monetizar suas APIs.

Etapa	Descrição
Gerenciar pacotes de produtos de API	Crie pacotes de produtos de API para agrupar seus produtos de API. Observação: na interface clássica do Edge e na API Monetization, os pacotes de produtos são chamados de pacotes de API. Para usar a API para gerenciar pacotes de produtos de API, consulte: Como criar um pacote de produtos de API usando a API Como gerenciar os produtos de API em um pacote de produtos de API usando a API Como visualizar pacotes de produtos de API usando a API Como visualizar pacotes de produtos de API aceitos por um desenvolvedor usando a API Como excluir um pacote de produtos de API
Configurar a política de gravação de transações	Configure a política de gravação de transações para cada um dos seus produtos de API. A política de gravação de transações define o que você quer capturar nos registros de transações de um produto de API, incluindo atributos personalizados. Para 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 de transação usando a API Como especificar atributos personalizados usando a API
Gerenciar e publicar planos de taxas	Crie um plano de taxas para definir a abordagem de monetização das suas APIs. Por exemplo, se você cobra uma taxa fixa ou variável pelo uso da sua API. Para gerenciar planos de taxas usando a API, consulte: Como visualizar planos de taxas usando a API Como criar planos de taxas usando a API Como editar um rascunho de plano de taxas usando a API Como excluir um rascunho de plano de taxas usando a API
Comprar um plano de taxas publicado	Compre um plano de taxas publicado e expire ou cancele um plano de taxas comprado, se quiser, usando a API.
Configurar a monetização no portal do desenvolvedor	Configure a monetização no portal do desenvolvedor para oferecer aos desenvolvedores acesso de autoatendimento para assinaturas do plano de taxas, processamento e faturamento de pagamentos automáticos, relatórios, catálogos de produtos e outras configurações específicas de monetização.

Gerenciar monetização

Depois de configurar a monetização e monetizar sua API, você poderá realizar uma ou mais das etapas resumidas na tabela a seguir:

Etapa	Descrição
Gerenciar empresas e desenvolvedores	Gerencie as empresas e os desenvolvedores que usam suas APIs. Um desenvolvedor é uma única entidade, 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 de saldo pré-pago, receita e variação. Para desenvolvedores pré-pagos, é possível conciliar relatórios de saldo pré-pago com depósitos bancários.
Fazer ajustes de faturamento	Faça ajustes de faturamento para corrigir discrepâncias nos seus registros, por exemplo.
Emitir créditos	Emita 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 do desenvolvedor. Para um desenvolvedor pós-pago, um crédito aparece como uma linha separada em uma fatura, reduzindo a cobrança em uma fatura.
Gerenciar saldos de contas pré-pagas	Consulte o saldo atual da conta pré-paga e recarregue contas pré-pagas ou configure a recarga automática usando um provedor de pagamentos de terceiros.
Gerenciar saldos pós-pagos usando limites de crédito	Ao adicionar uma moeda aceita para 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 para um desenvolvedor pós-pago individual. Nesse caso, o limite de crédito substitui qualquer limite definido para a moeda apenas para o desenvolvedor especificado.
Postar reembolsos	Poste reembolsos para desenvolvedores de transações de compra.
Programar jobs de monetização	A monetização oferece um programador de jobs e um conjunto de jobs pré-programados para serem executados em horários designados. Gerencie a programação de jobs de monetização usando a API.
Conferir o status das transações	Consulte o status das transações que ocorreram durante um período especificado usando a API.
Sincronizar dados do Apigee Edge com a monetização	Se instruído a fazer isso pela Apigee, resincronize os dados com a monetização para garantir que os dados estejam sincronizados. É possível sincronizar o seguinte: organização, produtos de API, desenvolvedores e aplicativos.
Excluir dados de monetização da sua organização	Talvez você queira excluir dados de monetização da sua organização para limpar uma organização de teste ou excluir uma organização.